omniauth-mollie 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1e942dc0a54e65cdac58532b2bc09333d6dfe25a
-  data.tar.gz: a657353ed32171f780b4c3eb2ad72e4b43861ca4
+  metadata.gz: 5d79c4da0c4822bad19b7929154fadd5b3c63b23
+  data.tar.gz: 3e820e6d9f5605b2a05fdd663ccab5a84269b630
 SHA512:
-  metadata.gz: 2ebec3d249b17053abf0e235cee5219f6c6f111c9b2954ead2c76d625e170603d13a472c8a8da1310092acc0b6bd6b8217e445d7b77d63dd53cd83f7112e2798
-  data.tar.gz: c89686f3a762a38a5c9594cade542a297d716d201ec18bceba4a524d4a4b1284e599bdc4f9b9dc3670d01cf16cdba529e32141e77110ffe86aadf6f80526cf8e
+  metadata.gz: 76181f2bf8f78abeaec154b7382703b3ebace77369eb2810986c49fa67682007b75548366edac4466fe7da83ad35f669ce4bf004cd69c4bc855d70dde9bbb8e2
+  data.tar.gz: 7c3c581c7d8e4670ebe1413452855ee78651f05d0716c2876cd5941c6285c5755b998478a8e705aac33be05416d6c98b475f149ff1801e5ac1a1948e814d698b

data/README.md

@@ -1,8 +1,6 @@
-# Omniauth::Mollie
+# OmniAuth::Mollie
 
-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/mollie`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+This is a OmniAuth 1.0 strategy for [Mollie Connect](https://www.mollie.com/en/docs/oauth/overview).
 
 ## Installation
 
@@ -22,17 +20,57 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### 1. Add the Rack Middleware and configure Mollie Credentials
+
+Add the Mollie provider to your OmniAuth initializer or create one in `config/initializers/omniauth.rb`. 
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :mollie, ENV['MOLLIE_CLIENT_ID'], ENV['MOLLIE_CLIENT_SECRET'], { provider_ignores_state: true }
+end
+```
+
+Important is the `{ provider_ignores_state: true }`, which is necessary in order to make it work. Replace `ENV['MOLLIE_CLIENT_ID']` and `ENV['MOLLIE_SECRET']` credentials with yours. To aquire these credentials, you'll have to create a [Mollie Application](https://www.mollie.com/dashboard/settings/applications).
+
+
+Use the following redirect URL: `https://[YOUR DOMAIN]/auth/mollie/callback`
+
+### 2. Connect with Mollie
+
+After you set up the Rack Middeware and configured Mollie Credentials, you're ready to let users connect with Mollie. To do, let users to go `/auth/mollie`, which will redirect you to Mollie and connect.
+
+When you are connected, you'll receive an Auth Hash back from calling `request.env['omniauth.auth']`. This is an example Auth Hash:
+
+```ruby
+{
+  "provider" => "mollie",
+  "uid" => "<MOLLIE_ORGANIZATION_ID>",
+  "credentials" => {
+    "token" => "<MOLLIE_ACCESS_TOKEN>",
+    "refresh_token" => "<MOLLIE_REFRESH_TOKEN>",
+    "expires" => 1489583888,
+  },
+  "extra"=> {
+    "name" =>"<MOLLIE_ORGANIZATION_NAME>",
+    "email" => "<MOLLIE_ORGANIZATION_EMAIL>",
+    "address" => "<MOLLIE_ORGANIZATION_ADDRESS>",
+    "postalCode" => "<MOLLIE_ORGANIZATION_POSTAL_CODE>",
+    "city" => "<MOLLIE_ORGANIZATION_CITY>",
+    "country" => "<MOLLIE_ORGANIZATION_COUNTRY>",
+    "countryCode" => "<MOLLIE_ORGANIZATION_COUNTRY_CODE>",
+  },
+}
+```
 
-## Development
+## Known limitations
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+1. This only allows you to have the following [Mollie Permissions](https://www.mollie.com/nl/docs/oauth/permissions): `payments.read, customers.read, subscriptions.read, organizations.read`. Please create a pull request if you'd like the gem to have more permissions.
 
-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).
+2. Mollie's access tokens expire in **1 hour**, and their refresh tokens expire in **2 weeks**. I contacted Mollie to extend this period or completely remove expirations from access tokens, but have yet to do this. Please [contact Mollie](https://help.mollie.com/hc/en/requests/new) to convince them to do the latter.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/omniauth-mollie.
+Bug reports and pull requests are welcome on GitHub at https://github.com/jenskanis/omniauth-mollie.
 
 
 ## License

data/lib/omniauth/mollie/version.rb

@@ -1,5 +1,5 @@
 module Omniauth
   module Mollie
-    VERSION = "0.2.0"
+    VERSION = "0.3.0"
   end
 end

data/omniauth-mollie.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["me@jenskanis.nl"]
 
   spec.summary       = %q{Mollie Connect OAuth2 Strategy for OmniAuth 1.0.}
-  spec.homepage      = "https://www.mollie.com/en/docs/oauth/overview"
+  spec.homepage      = "https://github.com/jenskanis/omniauth-mollie"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
@@ -19,9 +19,7 @@ Gem::Specification.new do |spec|
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "bundler", "~> 1.14"
-  spec.add_development_dependency "rake", "~> 10.0"
+  
   spec.add_dependency 'omniauth', '~> 1.3'
   spec.add_dependency 'omniauth-oauth2', '~> 1.4'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-mollie
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Jens Kanis
@@ -10,34 +10,6 @@ bindir: exe
 cert_chain: []
 date: 2017-03-15 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.14'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.14'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
 - !ruby/object:Gem::Dependency
   name: omniauth
   requirement: !ruby/object:Gem::Requirement
@@ -83,9 +55,8 @@ files:
 - lib/omniauth/mollie.rb
 - lib/omniauth/mollie/version.rb
 - lib/omniauth/strategies/mollie.rb
-- omniauth-mollie-0.1.0.gem
 - omniauth-mollie.gemspec
-homepage: https://www.mollie.com/en/docs/oauth/overview
+homepage: https://github.com/jenskanis/omniauth-mollie
 licenses:
 - MIT
 metadata: {}