omniauth-cz-shop-platforms 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f9984d2d991ad71fe78baa870f609248b9e4c641fc7b4bdd295313001dada2b
-  data.tar.gz: 04ede54a6fb8a491088342058aa82a5300d755287427cb742029a2d0c026ea1f
+  metadata.gz: bf68b9e2a7e724dd5b53df846c87d9e154cf2bdf7f7cdb64105e9b20ea544043
+  data.tar.gz: 14e9a2512249d2cd21ed863893fde6242934fc7389bb5b0b6cba29f3eecee383
 SHA512:
-  metadata.gz: bb250e086ddf76deb65a67316ff90e619b77698dff4bc2d69bcc490df7b5c2f017a760fdb60a0bb153a6140a59bc5596e448b263dbfe604cf3414bbc4f4e96c6
-  data.tar.gz: 2deecd6b28aa63fa4f9ddf11e3187a93d1b469302750bd71409bd56dd435ec13c8f510b40028c8760e682f28396ce1f5e9ead58c49836b6d1388b30ea908cdfe
+  metadata.gz: 914b67cd782bd54a757bdb94ad3949d5a64e565f37f213d85a9cba49d601848a522b945b4e88c1d8fe10c98e260bea2e45d82c75feeb1e559c35a9e5469f38f8
+  data.tar.gz: 7ab29862c4f1c65aa370e76a8cd78bb101581e25a8d91310fb1572201621528cc9734fbabc34e134556b9867f2f0f6cc9baa5b9c4eea8f176233b9f078eb30d3

data/CHANGELOG.md

@@ -1,6 +1,20 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## 1.1.0 - 2022-04-11
+
+### Added
+- added strategy for shoptet.cz
+
+### Deprecated
+- Nothing.
+
+### Removed
+- cleaned up webareal code
+
+### Fixed
+- Nothing.
+
 ## 1.0.0 - 2022-03-20
 
 ### Added

data/lib/omniauth/cz_shop_platforms/version.rb

@@ -2,6 +2,6 @@
 
 module OmniAuth
   module CzShopPlatforms
-    VERSION = '1.0.0'
+    VERSION = '1.1.0'
   end
 end

data/lib/omniauth/cz_shop_platforms.rb

@@ -1,3 +1,4 @@
 # frozen_string_literal: true
 
 require 'omniauth/strategies/web_areal'
+require 'omniauth/strategies/shoptet'

data/lib/omniauth/strategies/shoptet.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require 'oauth2'
+require 'omniauth/strategies/oauth2'
+require 'uri'
+
+module OmniAuth
+  module Strategies
+    # Main class for Seznam.cz strategy.
+    class Shoptet < OmniAuth::Strategies::OAuth2
+      DEFAULT_SCOPE = 'basic_eshop'
+      USER_INFO_PATH = '/action/OAuthServer/resource?method=getBasicEshop'
+
+      option :name, 'shoptet'
+      option :scope, DEFAULT_SCOPE
+
+      option :client_options,
+             authorize_url: '/action/OAuthServer/authorize',
+             token_url: '/action/OAuthServer/token',
+             auth_scheme: :request_body
+      option :authorize_options, %i[scope]
+      option :token_options, %i[scope]
+
+      def client_site
+        if options.site
+          options.site
+        elsif request.params['shop_name']
+          shop_name = request.params['shop_name']
+          site = "https://#{shop_name}.myshoptet.com"
+          session['omniauth.shoptet.site'] = site
+          site
+        elsif session['omniauth.shoptet.site']
+          session['omniauth.shoptet.site']
+        else
+          raise 'Cannot determine client site, set :site option or shop_name request param.'
+        end
+      end
+
+      def client
+        client_options = deep_symbolize(options.client_options)
+        client_options[:site] = client_site
+        ::OAuth2::Client.new(options.client_id, options.client_secret, client_options)
+      end
+
+      uid { raw_info['data']['user']['email'] }
+
+      info do
+        {
+          email: raw_info['data']['user']['email'],
+          store: raw_info['data']['user']['project']
+        }
+      end
+
+      extra do
+        { 'raw_info' => raw_info }
+      end
+
+      def callback_url
+        full_host + callback_path
+      end
+
+      def raw_info
+        @raw_info ||= access_token.get(USER_INFO_PATH).parsed
+      end
+    end
+  end
+end

data/lib/omniauth/strategies/web_areal.rb

@@ -12,8 +12,8 @@ module OmniAuth
       USER_INFO_URL = 'https://marketplace.webareal.cz/api/user/about'
 
       option :name, 'web_areal'
-      option :authorize_options, %i[scope state redirect_uri]
-      option :authorized_client_ids, []
+      option :authorize_options, %i[scope]
+      option :scope, DEFAULT_SCOPE
 
       option :client_options,
              site: 'https://marketplace.webareal.cz',
@@ -21,16 +21,6 @@ module OmniAuth
              token_url: '/api/token',
              auth_scheme: :request_body
 
-      def authorize_params
-        super.tap do |params|
-          options[:authorize_options].each do |k|
-            params[k] = request.params[k.to_s] unless [nil, ''].include?(request.params[k.to_s])
-          end
-          params[:scope] ||= DEFAULT_SCOPE
-          session['omniauth.state'] = params[:state] if params[:state]
-        end
-      end
-
       uid { raw_info['user'] }
 
       info do

data/spec/omniauth/strategies/shoptet_spec.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'json'
+require 'omniauth-cz-shop-platforms'
+require 'stringio'
+
+describe OmniAuth::Strategies::Shoptet do
+  let(:request) { double('Request', params: @params || {}, cookies: {}, env: { 'rack.session' => @session || {} }) }
+  let(:app) do
+    lambda do
+      [200, {}, ['Hello.']]
+    end
+  end
+
+  subject do
+    OmniAuth::Strategies::Shoptet.new(app, 'appid', 'secret', @options || {}).tap do |strategy|
+      allow(strategy).to receive(:request) do
+        request
+      end
+      allow(strategy).to receive(:session) do
+        request.env['rack.session']
+      end
+    end
+  end
+
+  before do
+    OmniAuth.config.test_mode = true
+  end
+
+  after do
+    OmniAuth.config.test_mode = false
+  end
+
+  describe 'missing site information' do
+    it 'should raise error' do
+      expect { subject.client }.to raise_error(/Cannot determine client site/)
+    end
+  end
+
+  describe 'site override' do
+    before do
+      @options = { site: 'https://custom.site' }
+    end
+
+    it 'has site from options' do
+      expect(subject.client.site).to eq('https://custom.site')
+    end
+  end
+
+  describe 'on authorize' do
+    before do
+      @params = { 'shop_name' => 'awesome-shop' }
+    end
+
+    describe '#client_options' do
+      it 'has correct authorize_url' do
+        expect(subject.client.options[:authorize_url]).to eq('/action/OAuthServer/authorize')
+      end
+
+      it 'has correct token_url' do
+        expect(subject.client.options[:token_url]).to eq('/action/OAuthServer/token')
+      end
+
+      it 'has site from request param' do
+        expect(subject.client.site).to eq('https://awesome-shop.myshoptet.com')
+      end
+
+      describe 'overrides' do
+        it 'should allow overriding the authorize_url' do
+          @options = { client_options: { 'authorize_url' => 'https://example.com' } }
+          expect(subject.client.options[:authorize_url]).to eq('https://example.com')
+        end
+
+        it 'should allow overriding the token_url' do
+          @options = { client_options: { 'token_url' => 'https://example.com' } }
+          expect(subject.client.options[:token_url]).to eq('https://example.com')
+        end
+      end
+    end
+  end
+
+  describe '#authorize_params' do
+    it 'should include any authorize params passed in the :authorize_params option' do
+      @options = { authorize_params: { request_visible_actions: 'something', foo: 'bar', baz: 'zip' }, hd: 'wow', bad: 'not_included' }
+      expect(subject.authorize_params['request_visible_actions']).to eq('something')
+      expect(subject.authorize_params['foo']).to eq('bar')
+      expect(subject.authorize_params['baz']).to eq('zip')
+      expect(subject.authorize_params['bad']).to eq(nil)
+    end
+  end
+
+  describe 'token phase' do
+    before do
+      @session = { 'omniauth.shoptet.site' => 'SITE_SESSION' }
+    end
+
+    it 'should take client site from session' do
+      expect(subject.client.site).to eq('SITE_SESSION')
+    end
+  end
+
+  describe '#token_params' do
+    it 'should include any token params passed in the :token_params option' do
+      @options = { token_params: { foo: 'bar', baz: 'zip' } }
+      expect(subject.token_params['foo']).to eq('bar')
+      expect(subject.token_params['baz']).to eq('zip')
+    end
+  end
+
+  describe '#token_options' do
+    it 'should include top-level options that are marked as :token_options' do
+      @options = { token_options: %i[scope foo], scope: 'bar', foo: 'baz', bad: 'not_included' }
+      expect(subject.token_params['scope']).to eq('bar')
+      expect(subject.token_params['foo']).to eq('baz')
+      expect(subject.token_params['bad']).to eq(nil)
+    end
+  end
+end

data/spec/omniauth/strategies/web_areal_spec.rb

@@ -79,68 +79,6 @@ describe OmniAuth::Strategies::WebAreal do
     end
   end
 
-  describe '#authorize_options' do
-    describe 'redirect_uri' do
-      it 'should default to nil' do
-        @options = {}
-        expect(subject.authorize_params['redirect_uri']).to eq(nil)
-      end
-
-      it 'should set the redirect_uri parameter if present' do
-        @options = { redirect_uri: 'https://example.com' }
-        expect(subject.authorize_params['redirect_uri']).to eq('https://example.com')
-      end
-    end
-
-    describe 'state' do
-      it 'should set the state parameter' do
-        @options = { state: 'some_state' }
-        expect(subject.authorize_params['state']).to eq('some_state')
-        expect(subject.authorize_params[:state]).to eq('some_state')
-        expect(subject.session['omniauth.state']).to eq('some_state')
-      end
-
-      it 'should set the omniauth.state dynamically' do
-        allow(subject).to receive(:request) { double('Request', params: { 'state' => 'some_state' }, env: {}) }
-        expect(subject.authorize_params['state']).to eq('some_state')
-        expect(subject.authorize_params[:state]).to eq('some_state')
-        expect(subject.session['omniauth.state']).to eq('some_state')
-      end
-    end
-
-    describe 'overrides' do
-      it 'should include top-level options that are marked as :authorize_options' do
-        @options = { authorize_options: %i[scope foo request_visible_actions], scope: 'http://bar', foo: 'baz', hd: 'wow', request_visible_actions: 'something' }
-        expect(subject.authorize_params['scope']).to eq('http://bar')
-        expect(subject.authorize_params['foo']).to eq('baz')
-        expect(subject.authorize_params['hd']).to eq(nil)
-        expect(subject.authorize_params['request_visible_actions']).to eq('something')
-      end
-
-      describe 'request overrides' do
-        %i[scope state].each do |k|
-          context "authorize option #{k}" do
-            let(:request) { double('Request', params: { k.to_s => 'http://example.com' }, cookies: {}, env: {}) }
-
-            it "should set the #{k} authorize option dynamically in the request" do
-              @options = { k: '' }
-              expect(subject.authorize_params[k.to_s]).to eq('http://example.com')
-            end
-          end
-        end
-
-        describe 'custom authorize_options' do
-          let(:request) { double('Request', params: { 'foo' => 'something' }, cookies: {}, env: {}) }
-
-          it 'should support request overrides from custom authorize_options' do
-            @options = { authorize_options: [:foo], foo: '' }
-            expect(subject.authorize_params['foo']).to eq('something')
-          end
-        end
-      end
-    end
-  end
-
   describe '#authorize_params' do
     it 'should include any authorize params passed in the :authorize_params option' do
       @options = { authorize_params: { request_visible_actions: 'something', foo: 'bar', baz: 'zip' }, hd: 'wow', bad: 'not_included' }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-cz-shop-platforms
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Jan Sterba
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-21 00:00:00.000000000 Z
+date: 2022-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2
@@ -113,8 +113,10 @@ files:
 - lib/omniauth-cz-shop-platforms.rb
 - lib/omniauth/cz_shop_platforms.rb
 - lib/omniauth/cz_shop_platforms/version.rb
+- lib/omniauth/strategies/shoptet.rb
 - lib/omniauth/strategies/web_areal.rb
 - omniauth-cz-shop-platforms.gemspec
+- spec/omniauth/strategies/shoptet_spec.rb
 - spec/omniauth/strategies/web_areal_spec.rb
 - spec/rubocop_spec.rb
 - spec/spec_helper.rb