webflow-rb 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: caf289ff080b55720bef55a8fe1ff021d43a3c44ae0fb94ee7c6517c6495af44
+  data.tar.gz: e44d6b178c268e754a7d2c7653f7bcb6eb78daddef16bcba0156d8a8dbc43092
+SHA512:
+  metadata.gz: '00918cd8a2991b4e64478b6695a93e828ac7b89a40be5fc03617c5d7d50580743ff9d3a62f36c76c4b41aaeabcb0e9611cecce6155cce698fa52b4f714ed8230'
+  data.tar.gz: 0dfdce4df3b8b8fd246796313e0e0e4c7d529d6b58d81dd668b0f764f8dc298b1c35729b0fd9edc43eb472e73d37ab84ec9cde143340a8b45fdb4e7af3eb502e

data/.github/workflows/build.yaml

@@ -0,0 +1,19 @@
+name: build
+
+on:
+  push:
+  pull_request:
+
+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 }}
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      - run: bundle exec rake

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem
+*.swo
+*.swp
+
+.irb_history

data/.irbrc

@@ -0,0 +1,5 @@
+$LOAD_PATH.unshift File.expand_path('lib')
+
+require 'webflow'
+
+@client = Webflow::Client.new(ENV.fetch('TEST_API_TOKEN'))

data/.rubocop.yml

@@ -0,0 +1,18 @@
+require:
+  - rubocop-minitest
+
+AllCops:
+  TargetRubyVersion: 2.7.0
+  NewCops: enable
+
+Layout/LineLength:
+  Max: 140
+Metrics/ClassLength:
+  Enabled: false
+Style/Documentation:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Style/HashSyntax:
+  Enabled: true
+  EnforcedShorthandSyntax: never

data/.ruby-version

@@ -0,0 +1 @@
+3.2.2

data/CHANGELOG.md

@@ -0,0 +1,34 @@
+## 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

data/Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'bundler', '> 1.13'
+gem 'byebug'
+gem 'minitest', '> 5.0'
+gem 'pry'
+gem 'rake', '> 10.0'
+gem 'rubocop'
+gem 'rubocop-minitest'
+gem 'vcr'
+gem 'webmock'

data/Gemfile.lock

@@ -0,0 +1,73 @@
+PATH
+  remote: .
+  specs:
+    webflow-rb (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.5)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    crack (0.4.5)
+      rexml
+    hashdiff (1.0.1)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    method_source (1.0.0)
+    minitest (5.14.4)
+    parallel (1.23.0)
+    parser (3.2.2.4)
+      ast (~> 2.4.1)
+      racc
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (5.0.3)
+    racc (1.7.3)
+    rainbow (3.1.1)
+    rake (13.1.0)
+    regexp_parser (2.8.2)
+    rexml (3.2.6)
+    rubocop (1.57.2)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.4)
+      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)
+      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)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (2.5.0)
+    vcr (6.2.0)
+    webmock (3.19.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (> 1.13)
+  byebug
+  minitest (> 5.0)
+  pry
+  rake (> 10.0)
+  rubocop
+  rubocop-minitest
+  vcr
+  webflow-rb!
+  webmock
+
+BUNDLED WITH
+   2.4.22

data/LICENSE.txt

@@ -0,0 +1,21 @@
+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/README.md

@@ -0,0 +1,66 @@
+# Webflow [![Build Status](https://github.com/vfonic/webflow-rb/workflows/build/badge.svg)](https://github.com/vfonic/webflow-rb/actions)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'webflow-rb'
+```
+
+And then execute:
+
+```bash
+bundle
+```
+
+Or install it yourself as:
+
+```bash
+gem install webflow-rb
+```
+
+## Usage
+
+Check out [lib/webflow/client.rb](lib/webflow/client.rb).
+
+Check the documentation at: https://developers.webflow.com/reference/list-collection-items
+
+Basic usage:
+
+```ruby
+client = Webflow::Client.new(ENV.fetch('WEBFLOW_API_TOKEN'))
+sites = client.sites
+```
+
+Here are method signatures:
+
+```ruby
+def sites
+def site(site_id)
+def publish(site_id)
+def collections(site_id)
+def collection(collection_id)
+def list_items(collection_id, limit: 100, offset: 0)
+def list_all_items(collection_id)
+def get_item(collection_id, item_id)
+def create_item(collection_id, data)
+def update_item(collection_id, item_id, data)
+def delete_item(collection_id, item_id)
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome!
+
+## Plugins
+
+- [webflow_sync](https://github.com/vfonic/webflow_sync) - Keep Rails models in sync with WebFlow collections.
+
+## Thanks and Credits
+
+This gem wouldn't be possible without the amazing work of [webflow-ruby](https://github.com/penseo/webflow-ruby) gem. Thank you, [@phoet](https://github.com/phoet) and [@sega](https://github.com/sega)!
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,14 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rubocop/rake_task'
+
+Rake::TestTask.new(:test) do |t|
+  ENV['TEST_API_TOKEN'] = 'your_api_token_here' if ENV['TEST_API_TOKEN'].nil?
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+RuboCop::RakeTask.new
+
+task default: %i[rubocop test]

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'webflow'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/webflow/client.rb

@@ -0,0 +1,140 @@
+require 'net/http'
+require 'json'
+
+module Webflow
+  class Client
+    HOST = 'https://api.webflow.com/v2'.freeze
+    PAGINATION_LIMIT = 100
+
+    def initialize(token = Webflow.config.api_token)
+      @token = token
+    end
+
+    def sites
+      get('/sites').fetch(:sites)
+    end
+
+    def site(site_id)
+      get("/sites/#{site_id}")
+    end
+
+    def publish(site_id)
+      custom_domains = site(site_id).fetch(:customDomains).map { |domain| domain[:id] }
+      post("/sites/#{site_id}/publish", { publishToWebflowSubdomain: true, customDomains: custom_domains })
+    end
+
+    def collections(site_id)
+      get("/sites/#{site_id}/collections").fetch(:collections)
+    end
+
+    def collection(collection_id)
+      get("/collections/#{collection_id}")
+    end
+
+    # https://developers.webflow.com/reference/list-collection-items
+    #
+    # {
+    #   items: [] your list of items returned,
+    #   pagination: {
+    #     limit:  the limit specified in the request (default: 100),
+    #     offset: the offset specified for pagination (default: 0),
+    #     total:  total # of items in the collection
+    #   }
+    # }
+    def list_items(collection_id, limit: PAGINATION_LIMIT, offset: 0)
+      limit = [limit, PAGINATION_LIMIT].min
+      get("/collections/#{collection_id}/items", { limit: limit, offset: offset }).fetch(:items)
+    end
+
+    def list_all_items(collection_id) # rubocop:disable Metrics/MethodLength
+      fetched_items = []
+      offset = 0
+
+      loop do
+        response = get("/collections/#{collection_id}/items", { limit: PAGINATION_LIMIT, offset: offset })
+        items = response.fetch(:items)
+
+        if block_given?
+          yield(items)
+        else
+          fetched_items.concat(items)
+        end
+
+        offset += PAGINATION_LIMIT
+        break if offset >= response.dig(:pagination, :total)
+      end
+
+      fetched_items
+    end
+
+    def get_item(collection_id, item_id)
+      get("/collections/#{collection_id}/items/#{item_id}")
+    end
+
+    def create_item(collection_id, data)
+      result = post("/collections/#{collection_id}/items", { isArchived: false, isDraft: false, fieldData: data })
+      publish_item(collection_id, result.fetch(:id))
+      result
+    end
+
+    def update_item(collection_id, item_id, data)
+      result = patch("/collections/#{collection_id}/items/#{item_id}", { isArchived: false, isDraft: false, fieldData: data }.compact)
+      publish_item(collection_id, item_id)
+      result
+    end
+
+    def delete_item(collection_id, item_id)
+      # deleting items from Webflow doesn't work as expected.
+      # if we delete without archiving, the item will stay visible on the site until the site is published
+      # if we first archive + publish item, the item will be set as archived and not visible on the site
+      # then we call delete to remove the item from Webflow CMS
+      patch("/collections/#{collection_id}/items/#{item_id}", { isArchived: true, isDraft: false })
+      publish_item(collection_id, item_id)
+      delete("/collections/#{collection_id}/items/#{item_id}")
+    end
+
+    private
+
+    def publish_item(collection_id, item_id)
+      post("/collections/#{collection_id}/items/publish", { itemIds: Array(item_id) })
+    end
+
+    def get(path, data = nil)
+      request(path, method: :get, data: data)
+    end
+
+    def post(path, data)
+      request(path, method: :post, data: data)
+    end
+
+    def patch(path, data)
+      request(path, method: :patch, data: data)
+    end
+
+    def delete(path)
+      request(path, method: :delete)
+    end
+
+    def request(path, method:, data: nil) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+      url = URI.parse(HOST + path)
+      bearer = "Bearer #{@token}"
+      headers = { accept: 'application/json', 'content-type': 'application/json', authorization: bearer }
+      http = Net::HTTP.new(url.host, url.port)
+      http.use_ssl = true if url.scheme == 'https'
+
+      url.query = URI.encode_www_form(data) if data && method == :get
+
+      request_class = { get: Net::HTTP::Get, post: Net::HTTP::Post, patch: Net::HTTP::Patch, delete: Net::HTTP::Delete }.fetch(method)
+      request = request_class.new(url.to_s, headers)
+      request.body = data.to_json if %i[post patch].include?(method)
+
+      response = http.request(request)
+      body = response.read_body
+
+      result = JSON.parse(body, symbolize_names: true) unless body.nil?
+      raise Webflow::Error, result if response.code.to_i >= 400
+
+      result
+    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,20 @@
+module Webflow
+  class Error < StandardError
+    attr_reader :data
+
+    def initialize(data)
+      @data = data
+
+      message = "#{data[:message]}#{": #{Array(details)}" if details?}"
+      super(message)
+    end
+
+    def details?
+      details && !details.empty?
+    end
+
+    def details
+      data[:details]
+    end
+  end
+end

data/lib/webflow/ruby.rb

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

data/lib/webflow/version.rb

@@ -0,0 +1,3 @@
+module Webflow
+  VERSION = '1.0.0'.freeze
+end

data/lib/webflow.rb

@@ -0,0 +1 @@
+require 'webflow/ruby'

data/webflow.gemspec

@@ -0,0 +1,25 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'webflow/version'
+
+Gem::Specification.new do |spec|
+  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.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.metadata['rubygems_mfa_required'] = 'true'
+  spec.required_ruby_version = '>= 2.7.0'
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: webflow-rb
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- phoet
+- vfonic
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-12-05 00:00:00.000000000 Z
+dependencies: []
+description: Webflow API wrapper
+email:
+- phoetmail@googlemail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/build.yaml"
+- ".gitignore"
+- ".irbrc"
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- 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
+homepage: https://github.com/vfonic/webflow-rb
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.22
+signing_key:
+specification_version: 4
+summary: Webflow API wrapper
+test_files: []