penseo/webflow-ruby

🕸 🌀Webflow API bindings for Ruby

Webflow

Installation

Add this line to your application's Gemfile:

gem 'webflow-ruby'

And then execute:

$ bundle

Or install it yourself as:

$ gem install webflow-ruby

Usage

Have a look at the tests, seriously!

Quick Start

client = Webflow::Client.new(WEBFLOW_API_TOKEN)
sites = client.sites

Todo

• Resource mapping, it's plain hashes for now
• Proper docs (please look at the tests for now)

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/penseo/webflow-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

Plugins

• webflow_sync - Keep Rails models in sync with WebFlow collections.

License

The gem is available as open source under the terms of the MIT License.

webflow-ruby's Issues

Version bump?

hey @phoet - could you please release a new version w/ the pagination changes in place? thanks!

Unable to update _draft with 1.2.0

Hi All,

I just updated from 1.1.0 to 1.2.0 and it seems that I can no longer update the _draft attribute of my items from true to false. Does anyone have any pointers on what I'm doing wrong?

Let consumers of the gem handle pagination

Currently the gem paginates for you, often leading to the rate limit being hit and difficult-to-handle exceptions being thrown. While I think it's good to introduce an exception for when the rate limit is hit, I also think that pagination should be left up to the consumer of the gem (as mentioned here).

That way, we don't end up with being half-way through iterating through a collection and then getting the RateLimitError thrown. Plus, then it's a more faithful mirroring of the actual RESTful API.

Thoughts?

webflow-ruby is not compatible with http v5

Hey,

I just ran bundle update and it updated 'http' gem from v4.4.1 to v5.

Seems like 'http' v5 does not have method request here:
https://github.com/penseo/webflow-ruby/blob/master/lib/webflow/client.rb#L130

Maybe the 'http' dependency version number should be restricted? Or some other method could be used to get request data?

PS This is their changelog: https://github.com/httprb/http/blob/master/CHANGES.md#500-2021-05-12

Support for patching items

Partial update support seems to have been added to the api - would love support for this!

Thanks for writing this project :)

We've built WebflowSync on top of webflow-ruby!

Hey @phoet!

Thank you for creating webflow-ruby!

Just wanted to let you know that @stankovicjovana, @markokacanski and I built webflow_sync gem that syncs Rails models to WebFlow. The gem has been developed over the past couple of days, but we plan to keep adding new features and using it in live webapp soon.

I'd be curious to hear your thoughts, especially if you need a similar functionality.

Thanks!
Viktor