omniauth-webflow 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0fed9cba5d4964c45b457465ccefad47c7dc6aeffaaf955b900c4e4c486822f3
-  data.tar.gz: add603d9545e3a6adf19c4eabaa38dd1db899fcee1e4ca4975548ab9296fd428
+  metadata.gz: 4ad987f587504fabb5720eaa3477450f4670cf147e98b5fb9daaf104250e7823
+  data.tar.gz: 4e6d2c5c10ff603dd00fc10fc4708510cc6b94ddc5c7948ffb381913b0569245
 SHA512:
-  metadata.gz: e85ff27f24d19aa6333f0b0438c20b877c832ec29335e3bba02c7d87e12ff8d0720e4985efb8051c94202b18a7180a364e3e1490c7fc3bd960c1fd5dc6d638aa
-  data.tar.gz: cd66baa06ddbdd1140404fda5ebf414a6def345693178daf2a47ac871c40b9fd81da050d28f45f94e46f13f30a45ac08576519b875abce0ba9a12b431d6562d1
+  metadata.gz: 4dc8f3bf741a1a3c153e95ebaf740e33d544d8a4e7e3e24d98e92a6b17221200ad44f851a5f08dc67f6eaa16683f33c2542e8f59fc18bc01791436c4a2de5d89
+  data.tar.gz: fc3d3ec53a6486a2bfbef7ace67e037bdc97db38ec72f9055ba5ae4c7240b50ccd8f09eb2c3e3d7270fc67fb24c4d91468e9bb7861a45a07a8bf001411579993

data/Development.md

@@ -0,0 +1,7 @@
+Build the gem
+
+gem build omniauth-webflow.gemspec
+
+Then publish the gem
+
+bundle exec rake release

data/Gemfile.lock

@@ -1,34 +1,54 @@
 PATH
   remote: .
   specs:
-    omniauth-webflow (0.1.0)
-      multi_json (= 1.14.1)
-      omniauth-oauth2 (= 1.6.0)
+    omniauth-webflow (0.2.1)
+      multi_json (~> 1.15)
+      omniauth-oauth2 (~> 1.7)
 
 GEM
   remote: https://rubygems.org/
   specs:
     diff-lcs (1.3)
-    faraday (1.0.1)
+    faraday (1.8.0)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0.1)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.1)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
       multipart-post (>= 1.2, < 3)
-    hashie (4.1.0)
-    jwt (2.2.1)
-    multi_json (1.14.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    hashie (5.0.0)
+    jwt (2.3.0)
+    multi_json (1.15.0)
     multi_xml (0.6.0)
     multipart-post (2.1.1)
-    oauth2 (1.4.4)
+    oauth2 (1.4.7)
       faraday (>= 0.8, < 2.0)
       jwt (>= 1.0, < 3.0)
       multi_json (~> 1.3)
       multi_xml (~> 0.5)
       rack (>= 1.2, < 3)
-    omniauth (1.9.1)
+    omniauth (2.0.4)
       hashie (>= 3.4.6)
       rack (>= 1.6.2, < 3)
-    omniauth-oauth2 (1.6.0)
-      oauth2 (~> 1.1)
-      omniauth (~> 1.9)
-    rack (2.2.2)
+      rack-protection
+    omniauth-oauth2 (1.7.2)
+      oauth2 (~> 1.4)
+      omniauth (>= 1.9, < 3)
+    rack (2.2.3)
+    rack-protection (2.1.0)
+      rack
     rake (12.3.3)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
@@ -43,6 +63,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.3)
+    ruby2_keywords (0.0.5)
 
 PLATFORMS
   ruby

data/README.md

@@ -1,10 +1,18 @@
-# Omniauth::Webflow
+# omniauth-webflow
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/omniauth/webflow`. To experiment with that code, run `bin/console` for an interactive prompt.
+This gem is an [OmniAuth 1.0](https://github.com/omniauth/omniauth) Strategy for authenticating with the [Webflow API](https://developers.webflow.com/) (version 1.0.0)
 
-TODO: Delete this and the text above, and describe your gem
+## Setup
 
-## Installation
+First, you will need to register your application with Webflow. This can be done on the [Integrations](https://webflow.com/dashboard/account/integrations) tab.
+
+**Important:** your callback URL should be specified as `https://[hostname]/auth/webflow/callback`
+
+In order to authenticate with Webflow in both development and production we recommend registering a "-dev" app with Webflow that points at your localhost app. One thing to note here is that Webflow requires your callback url to be `https`.
+
+After registering a new application with Webflow take note of the `client_id` and `client_secret` provided. You should put these into your Rails credentials or store them as environment variables like `ENV['WEBFLOW_CLIENT_ID']` and `ENV['WEBFLOW_CLIENT_SECRET']`
+
+## Usage
 
 Add this line to your application's Gemfile:
 
@@ -16,24 +24,17 @@ And then execute:
 
     $ bundle install
 
-Or install it yourself as:
-
-    $ gem install omniauth-webflow
-
-## Usage
-
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+In your Rails app, add the Webflow provider to your Omniauth middleware, e.g. in a file like `config/initializers/omniauth.rb`:
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :webflow, ENV['WEBFLOW_CLIENT_ID'], ENV['WEBFLOW_CLIENT_SECRET']
+end
+```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/omniauth-webflow. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/omniauth-webflow/blob/master/CODE_OF_CONDUCT.md).
-
+Bug reports and pull requests are welcome on GitHub at https://github.com/wrk-corp/omniauth-webflow. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/wrk-corp/omniauth-webflow/blob/master/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -41,4 +42,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Omniauth::Webflow project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/omniauth-webflow/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Omniauth::Webflow project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/wrk-corp/omniauth-webflow/blob/master/CODE_OF_CONDUCT.md).

data/lib/omniauth/strategies/webflow.rb

@@ -3,26 +3,24 @@ require 'omniauth-oauth2'
 module OmniAuth
   module Strategies
     class Webflow < OmniAuth::Strategies::OAuth2
-      API_VERSION = "1.0.0"
+      API_VERSION = '1.0.0'.freeze
 
-      option :name, "webflow"
+      option :name, 'webflow'
       option :client_options, {
-        site: "https://api.webflow.com",
+        site: 'https://api.webflow.com',
         authorize_url: 'https://webflow.com/oauth/authorize',
         token_url: 'https://api.webflow.com/oauth/access_token'
       }
-      # option :token_params, { parse: :json }
-      # option :auth_token_params, { mode: :query, param_name: :token }
 
       uid { raw_info['_id'] }
 
       info do
         {
-          id: raw_info["_id"],
-          grant_type: raw_info["grantType"],
-          users: raw_info["users"],
-          orgs: raw_info["orgs"],
-          sites: raw_info["sites"],
+          id: raw_info['_id'],
+          grant_type: raw_info['grantType'],
+          users: raw_info['users'],
+          orgs: raw_info['orgs'],
+          sites: raw_info['sites']
         }
       end
 
@@ -36,14 +34,17 @@ module OmniAuth
         @raw_info ||= access_token.get("https://api.webflow.com/info?api_version=#{API_VERSION}").parsed
       end
 
-    protected
+      protected
 
-      # had to override this method as it was merging the redirect_uri into the params which was breaking the Webflow /access_token request
+      # callback_url includes the code parameter and Webflow decided to change their API recently
+      # to require the redirect_uri to match exactly what you have in your Webflow Application settings.
+      # This also means that you can not pass other url parameters through the redirect_uri.
       def build_access_token
-        verifier = request.params["code"]
-        client.auth_code.get_token(verifier, token_params.to_hash(:symbolize_keys => true), deep_symbolize(options.auth_token_params))
+        verifier = request.params['code']
+        uri = Addressable::URI.parse(callback_url)
+        redirect_uri = uri.omit(:query).to_s
+        client.auth_code.get_token(verifier, { redirect_uri: redirect_uri }.merge(token_params.to_hash(symbolize_keys: true)), deep_symbolize(options.auth_token_params))
       end
-
     end
   end
-end
+end

data/lib/omniauth-webflow/version.rb

@@ -1,5 +1,5 @@
 module Omniauth
   module Webflow
-    VERSION = "0.1.0"
+    VERSION = '0.2.1'.freeze
   end
 end

data/omniauth-webflow.gemspec

@@ -1,35 +1,35 @@
 require_relative 'lib/omniauth-webflow/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "omniauth-webflow"
+  spec.name          = 'omniauth-webflow'
   spec.version       = Omniauth::Webflow::VERSION
-  spec.authors       = ["Andrew"]
-  spec.email         = ["andrew@wrkhq.com"]
+  spec.authors       = ['Andrew']
+  spec.email         = ['andrew@wrkhq.com']
 
-  spec.summary       = %q{Omniauth strategy for Webflow}
-  spec.description   = %q{Omniauth strategy for Webflow}
-  spec.homepage      = "https://github.com/wrk-corp/omniauth-webflow"
-  spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+  spec.summary       = 'Omniauth strategy for Webflow'
+  spec.description   = 'Omniauth strategy for Webflow'
+  spec.homepage      = 'https://github.com/wrk-corp/omniauth-webflow'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
 
   # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
 
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/wrk-corp/omniauth-webflow"
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/wrk-corp/omniauth-webflow'
   # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
   # spec.add_runtime_dependency 'omniauth-oauth2'
   # spec.add_runtime_dependency 'multi_json'
 
-  spec.add_dependency 'omniauth-oauth2', '~> 1.6.0'
-  spec.add_dependency 'multi_json', '~> 1.13.1'
+  spec.add_dependency 'omniauth-oauth2', '~> 1.7'
+  spec.add_dependency 'multi_json', '~> 1.15'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-webflow
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Andrew
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-06-09 00:00:00.000000000 Z
+date: 2022-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth-oauth2
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.0
+        version: '1.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.0
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.13.1
+        version: '1.15'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.13.1
+        version: '1.15'
 description: Omniauth strategy for Webflow
 email:
 - andrew@wrkhq.com
@@ -51,6 +51,7 @@ files:
 - ".ruby-version"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
+- Development.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -68,7 +69,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/wrk-corp/omniauth-webflow
   source_code_uri: https://github.com/wrk-corp/omniauth-webflow
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -84,7 +85,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.2
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Omniauth strategy for Webflow
 test_files: []