webflow-rb 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2665b14b916cf27c16e8048c0999510e67f78218498c129a5418147b2b7f1fb9
-  data.tar.gz: 80a0f625df655493c0ba8bd6f5e56f0941690019bebd83c7d09334c04c92da11
+  metadata.gz: c0c9b85b178e6882ec10164f8477694c17f8a38be08981fd1d7bdc0c06d97817
+  data.tar.gz: 759ef621556f4bc958ddd3f9df95dc0c4e543d9e753a79a470c23fe76b3e4105
 SHA512:
-  metadata.gz: 17f659d54439c3736b0a128dfb63d2e6ad37cc7aa44c2ce76340fd72061e4c1433728d5f6eb515894ab69d8d94c7d36c8a2f809296d19d44ee0520b34023a55e
-  data.tar.gz: 3cb940cf715f7660f863ceeb2d8c6ba14e96fa1ed2b3ebced7eac82e439101475df180428086319ffba51527039fa102d5068c85b8462a851c82b9af37ee9d69
+  metadata.gz: 18b854f5373020d9aaad9106d71937882eb2a9b61945c30fec53534d928af7b74ee3f9dd3edc4804c12d058dcfc90ef235be2ca45dbb5703b1d2062da4647ed3
+  data.tar.gz: b21caaf7b2d6c27ae06d87490682146de30c79b020b219bcd70a75315839993c4f12a3d79318c3dcf614c21ecc6642d090e6104062ec8d33065ee1219f925f72

data/.github/workflows/build.yaml

@@ -6,14 +6,11 @@ on:
 
 jobs:
   build:
-    strategy:
-      matrix:
-        ruby: [2.7.2, 3.2.2]
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
       - uses: ruby/setup-ruby@v1
         with:
-          ruby-version: ${{ matrix.ruby }}
+          ruby-version: 3.4.4
           bundler-cache: true # runs 'bundle install' and caches installed gems automatically
       - run: bundle exec rake

data/.rubocop.yml

@@ -1,5 +1,6 @@
-require:
+plugins:
   - rubocop-minitest
+  - rubocop-rake
 
 AllCops:
   TargetRubyVersion: 2.7.0

data/.ruby-version

@@ -1 +1 @@
-3.2.2
+3.4.4

data/CHANGELOG.md

@@ -1,34 +1,6 @@
-## 2.0.0
-
-- [FEATURE] Upgrade to Webflow API v2 😍 @vfonic
-- [BREAKING] This version brings many breaking changes! All returned hashes' keys are symbolized. Webflow item fields are now located under `:fieldData` key in the hash: `client.item(collection_id, item_id).dig(:fieldData, :name)` 😍 @vfonic
-- [BREAKING] Check `lib/webflow/client.rb` for the full API.
-
-## 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
-
-## 0.5.0
-
-- [FEATURE] Pagination https://github.com/penseo/webflow-ruby/pull/2 😍 @cohesiveneal
+- Auto require / load the gem. You no longer need to `require 'webflow'` in your code.
+- Test on Ruby 3.4.4
+- Add query parameter support to list_items method https://github.com/vfonic/webflow-rb/pull/4 @pjpires
+- Adding Rate Limit Handling to Client https://github.com/vfonic/webflow-rb/pull/3 @ScotterC

data/Gemfile

@@ -9,5 +9,6 @@ gem 'pry'
 gem 'rake', '> 10.0'
 gem 'rubocop'
 gem 'rubocop-minitest'
+gem 'rubocop-rake'
 gem 'vcr'
 gem 'webmock'

data/Gemfile.lock

@@ -1,55 +1,69 @@
 PATH
   remote: .
   specs:
-    webflow-rb (1.1.1)
+    webflow-rb (1.2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.8.5)
-      public_suffix (>= 2.0.2, < 6.0)
-    ast (2.4.2)
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
+    ast (2.4.3)
+    base64 (0.3.0)
+    bigdecimal (3.2.2)
     byebug (11.1.3)
     coderay (1.1.3)
-    crack (0.4.5)
+    crack (1.0.0)
+      bigdecimal
       rexml
-    hashdiff (1.0.1)
-    json (2.6.3)
-    language_server-protocol (3.17.0.3)
+    hashdiff (1.2.0)
+    json (2.12.2)
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
     method_source (1.0.0)
-    minitest (5.14.4)
-    parallel (1.23.0)
-    parser (3.2.2.4)
+    minitest (5.25.5)
+    parallel (1.27.0)
+    parser (3.3.8.0)
       ast (~> 2.4.1)
       racc
+    prism (1.4.0)
     pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    public_suffix (5.0.3)
-    racc (1.7.3)
+    public_suffix (6.0.2)
+    racc (1.8.1)
     rainbow (3.1.1)
-    rake (13.1.0)
-    regexp_parser (2.8.2)
-    rexml (3.2.6)
-    rubocop (1.57.2)
+    rake (13.3.0)
+    regexp_parser (2.10.0)
+    rexml (3.4.1)
+    rubocop (1.77.0)
       json (~> 2.3)
-      language_server-protocol (>= 3.17.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
       parallel (~> 1.10)
-      parser (>= 3.2.2.4)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.28.1, < 2.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.45.1, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.30.0)
-      parser (>= 3.2.1.0)
-    rubocop-minitest (0.33.0)
-      rubocop (>= 1.39, < 2.0)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.45.1)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
+    rubocop-minitest (0.38.1)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.75.0, < 2.0)
+      rubocop-ast (>= 1.38.0, < 2.0)
+    rubocop-rake (0.7.1)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.72.1)
     ruby-progressbar (1.13.0)
-    unicode-display_width (2.5.0)
-    vcr (6.2.0)
-    webmock (3.19.1)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
+    vcr (6.3.1)
+      base64
+    webmock (3.25.1)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
@@ -65,9 +79,10 @@ DEPENDENCIES
   rake (> 10.0)
   rubocop
   rubocop-minitest
+  rubocop-rake
   vcr
   webflow-rb!
   webmock
 
 BUNDLED WITH
-   2.4.22
+   2.6.9

data/LICENSE

@@ -0,0 +1,18 @@
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/webflow/client.rb

@@ -41,9 +41,9 @@ module Webflow
     #     total:  total # of items in the collection
     #   }
     # }
-    def list_items(collection_id, limit: PAGINATION_LIMIT, offset: 0)
+    def list_items(collection_id, limit: PAGINATION_LIMIT, offset: 0, query_params: {})
       limit = [limit, PAGINATION_LIMIT].min
-      get("/collections/#{collection_id}/items", { limit: limit, offset: offset }).fetch(:items)
+      get("/collections/#{collection_id}/items", query_params.merge(limit: limit, offset: offset)).fetch(:items)
     end
 
     def list_all_items(collection_id) # rubocop:disable Metrics/MethodLength
@@ -132,10 +132,27 @@ module Webflow
       request.body = data.to_json if %i[post patch].include?(method)
 
       response = http.request(request)
-      body = response.read_body
+      handle_response(response)
+    rescue Webflow::RateLimitError => e
+      retry_after = e.response['retry-after'].to_i
+      sleep retry_after
+      # Retry once
+      response = http.request(request)
+      handle_response(response)
+    end
 
+    def handle_response(response) # rubocop:disable Metrics/MethodLength
+      body = response.read_body
       result = JSON.parse(body, symbolize_names: true) unless body.nil?
-      raise Webflow::Error, result if response.code.to_i >= 400
+
+      case response.code.to_i
+      when 429
+        error = RateLimitError.new(result)
+        error.instance_variable_set(:@response, response)
+        raise error
+      when 400..599
+        raise Webflow::Error, result
+      end
 
       result
     end

data/lib/webflow/error.rb

@@ -1,6 +1,6 @@
 module Webflow
   class Error < StandardError
-    attr_reader :data
+    attr_reader :data, :response
 
     def initialize(data)
       @data = data
@@ -17,4 +17,6 @@ module Webflow
       data[:details]
     end
   end
+
+  class RateLimitError < Error; end
 end

data/lib/webflow/version.rb

@@ -1,3 +1,3 @@
 module Webflow
-  VERSION = '1.1.1'.freeze
+  VERSION = '1.2.0'.freeze
 end

data/lib/webflow-rb.rb

@@ -0,0 +1,3 @@
+# rubocop:disable Naming/FileName, Lint/MissingCopEnableDirective
+
+require 'webflow'

data/lib/webflow.rb

@@ -1 +1,7 @@
-require 'webflow/ruby'
+require 'webflow/version'
+require 'webflow/config'
+require 'webflow/client'
+require 'webflow/error'
+
+module Webflow
+end

data/webflow.gemspec

@@ -1,25 +1,18 @@
-lib = File.expand_path('lib', __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'webflow/version'
+# frozen_string_literal: true
+
+require_relative 'lib/webflow/version'
 
 Gem::Specification.new do |spec|
+  spec.required_ruby_version = '>= 2.7'
   spec.name          = 'webflow-rb'
   spec.version       = Webflow::VERSION
   spec.authors       = %w[phoet vfonic]
   spec.email         = ['phoetmail@googlemail.com']
-
-  spec.summary       = 'Webflow API wrapper'
-  spec.description   = spec.summary
   spec.homepage      = 'https://github.com/vfonic/webflow-rb'
+  spec.summary       = 'Webflow API wrapper'
   spec.license       = 'MIT'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
-  end
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
 
   spec.metadata['rubygems_mfa_required'] = 'true'
-  spec.required_ruby_version = '>= 2.7.0'
 end

metadata

@@ -1,17 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: webflow-rb
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - phoet
 - vfonic
-autorequire:
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2023-12-21 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
-description: Webflow API wrapper
 email:
 - phoetmail@googlemail.com
 executables: []
@@ -26,16 +24,16 @@ files:
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
-- LICENSE.txt
+- LICENSE
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
+- lib/webflow-rb.rb
 - 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
 homepage: https://github.com/vfonic/webflow-rb
@@ -43,7 +41,6 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -51,15 +48,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.22
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Webflow API wrapper
 test_files: []

data/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-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
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.

data/lib/webflow/ruby.rb

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