webflow-ruby 0.6.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f0ae105e0b3751752fb45b19468c361c969c283565bc604ee99a534f3bc93a3
-  data.tar.gz: d81ca44d2625e44a07b67fe7e71f8b7cb7133a89e861dc62abaa0fb1da22e35f
+  metadata.gz: 21d5899eec3b30b220cc9504ac6bfae90a5ca8513527a7549ae92e0f3506f9a8
+  data.tar.gz: be3d265daec2d442c26ceb5711991d665223ed919434066b13ede91f6f1ac6b9
 SHA512:
-  metadata.gz: 1c458dee0176fc2a97b6df6d67415a6c3ed88d83afb6e7991857db100bbd193a0208501e8c11b0d0628260af641630fd943536d885d9716277a54c11d76dff0f
-  data.tar.gz: de5e2448a9121fd9320f38ef74996a9201fd0d802079332e0666d0744bb8643019c1e007d4e59ef20e095e4dc7decc7b542c92edcdce24dd7682c8a49dfa95d8
+  metadata.gz: fc7d8c4dbd5b1e2305652a6909c7eb5c5d441338f7b0778644cce633640eb159d8b5893dd4ef93242712ae57f56b775443f64ca377101202b4ac79a355e95dee
+  data.tar.gz: dd9a55df590331f6dedc470055eff82d50511c19ca8d8d7eb80cd79ca4d8d0b66576373eac3562a0e93e9910a3f626038623d29cfbaaf2c65d78c69de7489ea2

data/.gitignore

@@ -7,3 +7,5 @@
 /spec/reports/
 /tmp/
 *.gem
+*.swo
+*.swp

data/.ruby-version

@@ -1 +1 @@
-2.5.3
+2.7.1

data/CHANGELOG.md

@@ -1,3 +1,22 @@
+## 1.2.1
+* [FEATURE] Handle Problems in Validation errors https://github.com/penseo/webflow-ruby/pull/14 https://github.com/penseo/webflow-ruby/pull/16 😍 @vfonic @sega
+
+## 1.2.0
+* [FEATURE] Add patch support for updating items https://github.com/penseo/webflow-ruby/issues/10 😍 @ukd1
+
+## 1.1.0
+
+* [FEATURE] Allow passing a block to `items` that yields the results by page https://github.com/penseo/webflow-ruby/issues/9 😍 @emilesilvis
+* [FEATURE] Handle Webflow live feature https://github.com/penseo/webflow-ruby/pull/8 😍 @emilesilvis
+
+## 1.0.0
+
+* [BREAKING] Raise errors when status > 200, see also https://github.com/penseo/webflow-ruby/pull/7 😍 @sega
+
+## 0.7.0
+
+* [FEATURE] Configuration class to store api token https://github.com/penseo/webflow-ruby/pull/6 😍 @mateuscruz
+
 ## 0.6.0
 
 * [CHANGE] Use pure ruby dependencies

data/Gemfile.lock

@@ -1,38 +1,43 @@
 PATH
   remote: .
   specs:
-    webflow-ruby (0.6.0)
+    webflow-ruby (1.2.0)
       http
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.6.0)
-      public_suffix (>= 2.0.2, < 4.0)
-    byebug (11.0.1)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    byebug (11.1.1)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
-    hashdiff (1.0.0)
-    http (4.1.1)
+    ffi (1.12.2)
+    ffi-compiler (1.0.1)
+      ffi (>= 1.0.0)
+      rake
+    hashdiff (1.0.1)
+    http (4.4.1)
       addressable (~> 2.3)
       http-cookie (~> 1.0)
-      http-form_data (~> 2.0)
-      http_parser.rb (~> 0.6.0)
+      http-form_data (~> 2.2)
+      http-parser (~> 1.2.0)
     http-cookie (1.0.3)
       domain_name (~> 0.5)
-    http-form_data (2.1.1)
-    http_parser.rb (0.6.0)
-    minitest (5.11.3)
-    public_suffix (3.1.1)
-    rake (12.3.3)
+    http-form_data (2.3.0)
+    http-parser (1.2.1)
+      ffi-compiler (>= 1.0, < 2.0)
+    minitest (5.14.0)
+    public_suffix (4.0.4)
+    rake (13.0.1)
     safe_yaml (1.0.5)
     unf (0.1.4)
       unf_ext
-    unf_ext (0.0.7.6)
-    vcr (5.0.0)
-    webmock (3.6.0)
+    unf_ext (0.0.7.7)
+    vcr (5.1.0)
+    webmock (3.8.3)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
@@ -48,6 +53,3 @@ DEPENDENCIES
   vcr
   webflow-ruby!
   webmock
-
-BUNDLED WITH
-   2.0.2

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2017 phoet
+Copyright (c) 2019 phoet
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,7 +1,6 @@
 # Webflow [![Build Status](https://travis-ci.org/penseo/webflow-ruby.svg?branch=master)](https://travis-ci.org/penseo/webflow-ruby)
 
 ## Installation
-
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -10,33 +9,35 @@ gem 'webflow-ruby'
 
 And then execute:
 
-    $ bundle
+```bash
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install webflow-ruby
+```bash
+$ gem install webflow-ruby
+```
 
 ## Usage
-
 Have a look at the tests, seriously!
 
 ### Quick Start
 ```ruby
-    client = Webflow::Client.new(WEBFLOW_API_TOKEN)
-    sites = client.sites
+client = Webflow::Client.new(WEBFLOW_API_TOKEN)
+sites = client.sites
 ```
 
 ## Todo
-
-* Error handling, it's all JSON for now
 * Resource mapping, it's plain hashes for now
-* Proper docs
+* 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](http://contributor-covenant.org) code of conduct.
 
+## Plugins
+* [webflow_sync](https://github.com/vfonic/webflow_sync) - Keep Rails models in sync with WebFlow collections.
 
-## License
 
+## License
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/webflow/client.rb

@@ -4,13 +4,21 @@ module Webflow
   class Client
     HOST = 'https://api.webflow.com'
 
-    def initialize(token)
-      @token = token
+    def initialize(token = nil)
+      @token = token || Webflow.config.api_token
       @rate_limit = {}
     end
 
     def rate_limit
-      @rate_limit
+      @rate_limit || {}
+    end
+
+    def limit
+      rate_limit['X-Ratelimit-Limit'].to_i
+    end
+
+    def remaining
+      rate_limit['X-Ratelimit-Remaining'].to_i
     end
 
     def info
@@ -31,7 +39,7 @@ module Webflow
 
     def publish(site_id, domain_names: nil)
       domain_names ||= domains(site_id).map { |domain| domain['name'] }
-      post("/sites/#{site_id}/publish", domains: domain_names)
+      post("/sites/#{site_id}/publish", {domains: domain_names})
     end
 
     def collections(site_id)
@@ -67,7 +75,9 @@ module Webflow
 
       num_pages.times do |i|
         resp = paginate_items(collection_id, per_page: per_page, page: i+1)
-        fetched_items += resp['items']
+        items = resp['items']
+        yield(items) if block_given?
+        fetched_items += items
         limit -= resp['count']
         break if limit <= 0 || resp['total'] <= fetched_items.length
       end
@@ -80,14 +90,12 @@ module Webflow
       json['items'].first
     end
 
-    def create_item(collection_id, data)
-      post("/collections/#{collection_id}/items", fields: data)
+    def create_item(collection_id, data, live: false)
+      post("/collections/#{collection_id}/items", {fields: data}, live: live)
     end
 
-    def update_item(item, data)
-      # FIXME: (PS) looks like the API does not have partial updates...
-      base = item.reject {|key, _| ['_id', 'published-by', 'published-on', 'created-on', 'created-by', 'updated-by', 'updated-on', '_cid'].include?(key) }
-      put("/collections/#{item['_cid']}/items/#{item['_id']}", fields: base.merge(data))
+    def update_item(item, data, live: false)
+      patch("/collections/#{item['_cid']}/items/#{item['_id']}", {fields: data}, live: live)
     end
 
     def delete_item(item)
@@ -100,12 +108,14 @@ module Webflow
       request(path, method: :get, params: params)
     end
 
-    def post(path, data)
-      request(path, method: :post, data: data)
+    def post(path, data, live: nil)
+      params = { live: 'true' } if live
+      request(path, method: :post, params: params, data: data)
     end
 
-    def put(path, data)
-      request(path, method: :put, data: data)
+    def patch(path, data, live: nil)
+      params = { live: 'true' } if live
+      request(path, method: :patch, params: params, data: data)
     end
 
     def delete(path)
@@ -119,30 +129,17 @@ module Webflow
 
       response = HTTP.auth(bearer).headers(headers).request(method, url, params: params, json: data)
 
-      rate_limit = response.headers.select { |key, value| key =~ /X-Ratelimit/ }.to_h
-      @rate_limit = rate_limit unless rate_limit.empty?
+      track_rate_limit(response.headers)
 
-      JSON.parse(response.body)
-    end
+      result = JSON.parse(response.body)
+      raise Webflow::Error.new(result) if response.code >= 400
 
-    def track_rate_limit(headers)
+      result
     end
 
-    # https://developers.webflow.com/#errors
-    def self.error_codes
-      {
-        [400,	SyntaxError] =>	'Request body was incorrectly formatted. Likely invalid JSON being sent up.',
-        [400,	InvalidAPIVersion] =>	'Requested an invalid API version',
-        [400,	UnsupportedVersion] =>	'Requested an API version that in unsupported by the requested route',
-        [400,	NotImplemented] =>	'This feature is not currently implemented',
-        [400,	ValidationError] =>	'Validation failure (see err field in the response)',
-        [400,	Conflict] =>	'Request has a conflict with existing data.',
-        [401,	Unauthorized] =>	'Provided access token is invalid or does not have access to requested resource',
-        [404,	NotFound] =>	'Requested resource not found',
-        [429,	RateLimit] =>	'The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses.',
-        [500,	ServerError] =>	'We had a problem with our server. Try again later.',
-        [400,	UnknownError] =>	'An error occurred which is not enumerated here, but is not a server error.',
-      }
+    def track_rate_limit(headers)
+      rate_limit = headers.select { |key, value| key =~ /X-Ratelimit/ }.to_h
+      @rate_limit = rate_limit unless rate_limit.empty?
     end
   end
 end

data/lib/webflow/config.rb

@@ -0,0 +1,15 @@
+module Webflow
+  class << self
+    def config
+      @config ||= Config.new
+    end
+
+    def configure
+      yield config
+    end
+  end
+
+  class Config
+    attr_accessor :api_token
+  end
+end

data/lib/webflow/error.rb

@@ -0,0 +1,43 @@
+module Webflow
+  class Error < StandardError
+    # https://developers.webflow.com/#errors
+    # 400 	SyntaxError 	Request body was incorrectly formatted. Likely invalid JSON being sent up.
+    # 400 	InvalidAPIVersion 	Requested an invalid API version
+    # 400 	UnsupportedVersion 	Requested an API version that in unsupported by the requested route
+    # 400 	NotImplemented 	This feature is not currently implemented
+    # 400 	ValidationError 	Validation failure (see problems field in the response)
+    # 400 	Conflict 	Request has a conflict with existing data.
+    # 401 	Unauthorized 	Provided access token is invalid or does not have access to requested resource
+    # 404 	NotFound 	Requested resource not found
+    # 429 	RateLimit 	The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses.
+    # 500 	ServerError 	We had a problem with our server. Try again later.
+    # 400 	UnknownError 	An error occurred which is not enumerated here, but is not a server error.
+    #
+    # Sample error response
+    #
+    # {
+    #   "msg": "Cannot access resource",
+    #   "code": 401,
+    #   "name": "Unauthorized",
+    #   "path": "/sites/invalid_site",
+    #   "err": "Unauthorized: Cannot access resource"
+    # }
+
+    attr_reader :data
+
+    def initialize(data)
+      @data = data
+
+      message = "#{data['msg']}#{': ' + Array(problems).join(', ') if problems?}"
+      super(message)
+    end
+
+    def problems?
+      !!data['problems']
+    end
+
+    def problems
+      data['problems']
+    end
+  end
+end

data/lib/webflow/ruby.rb

@@ -1,2 +1,4 @@
 require 'webflow/version'
+require 'webflow/config'
 require 'webflow/client'
+require 'webflow/error'

data/lib/webflow/version.rb

@@ -1,3 +1,3 @@
 module Webflow
-  VERSION = "0.6.0"
+  VERSION = "1.2.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webflow-ruby
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 1.2.1
 platform: ruby
 authors:
 - phoet
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-29 00:00:00.000000000 Z
+date: 2021-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -130,6 +130,8 @@ files:
 - bin/setup
 - lib/webflow.rb
 - lib/webflow/client.rb
+- lib/webflow/config.rb
+- lib/webflow/error.rb
 - lib/webflow/ruby.rb
 - lib/webflow/version.rb
 - webflow.gemspec
@@ -152,8 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Webflow API bindings for Ruby