omniauth-cz-shop-platforms 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9f9984d2d991ad71fe78baa870f609248b9e4c641fc7b4bdd295313001dada2b
+  data.tar.gz: 04ede54a6fb8a491088342058aa82a5300d755287427cb742029a2d0c026ea1f
+SHA512:
+  metadata.gz: bb250e086ddf76deb65a67316ff90e619b77698dff4bc2d69bcc490df7b5c2f017a760fdb60a0bb153a6140a59bc5596e448b263dbfe604cf3414bbc4f4e96c6
+  data.tar.gz: 2deecd6b28aa63fa4f9ddf11e3187a93d1b469302750bd71409bd56dd435ec13c8f510b40028c8760e682f28396ce1f5e9ead58c49836b6d1388b30ea908cdfe

data/.gitignore

@@ -0,0 +1,13 @@
+*.gem
+.bundle
+.config
+.ruby-gemset
+.ruby-version
+.rvmrc
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea/
+Gemfile.lock

data/.rubocop.yml

@@ -0,0 +1,20 @@
+Metrics/ClassLength:
+  Enabled: false
+Metrics/AbcSize:
+  Enabled: false
+Metrics/BlockLength:
+  ExcludedMethods: ['describe', 'context', 'shared_examples']
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Metrics/LineLength:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Enabled: false
+Naming:
+  Enabled: false
+Style/MutableConstant:
+  Enabled: false
+Gemspec/RequiredRubyVersion:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+cache: bundler
+rvm:
+  - '2.7.4'
+  - '3.0.0'

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+## 1.0.0 - 2022-03-20
+
+### Added
+- added strategy for webareal.cz
+
+### Deprecated
+- Nothing.
+
+### Removed
+- Nothing.
+
+### Fixed
+- Nothing.

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,28 @@
+[![Gem Version](https://badge.fury.io/rb/omniauth-cz-shop-platforms.svg)](https://badge.fury.io/rb/omniauth-cz-shop-platforms)
+[![Build Status](https://app.travis-ci.com/honzasterba/omniauth-cz-shop-platforms.svg?branch=main)](https://app.travis-ci.com/honzasterba/omniauth-cz-shop-platforms)
+
+# OmniAuth Strategies for czech eshop platforms
+
+Strategy to authenticate with various czech shop platforms
+
+ - [WebAreal.cz](https://marketplace.webareal.cz/doc/user-settings)
+
+## Installation
+
+Add to your `Gemfile`:
+
+```ruby
+gem 'omniauth-cz-shop-platforms'
+```
+
+Then `bundle install`.
+
+## License
+
+Copyright (c) 2018 by Jan Sterba
+
+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/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require File.join('bundler', 'gem_tasks')
+require File.join('rspec', 'core', 'rake_task')
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/publish-gem.sh

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+rm *.gem
+gem build omniauth-cz-shop-platforms.gemspec
+gem push omniauth-cz-shop-platforms-*.gem

data/lib/omniauth/cz_shop_platforms/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module OmniAuth
+  module CzShopPlatforms
+    VERSION = '1.0.0'
+  end
+end

data/lib/omniauth/cz_shop_platforms.rb

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

data/lib/omniauth/strategies/web_areal.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'oauth2'
+require 'omniauth/strategies/oauth2'
+require 'uri'
+
+module OmniAuth
+  module Strategies
+    # Main class for Seznam.cz strategy.
+    class WebAreal < OmniAuth::Strategies::OAuth2
+      DEFAULT_SCOPE = 'USER_INFO'
+      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 :client_options,
+             site: 'https://marketplace.webareal.cz',
+             authorize_url: '/user-auth',
+             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
+        {
+          email: raw_info['user'],
+          stores: raw_info['stores']
+        }
+      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_URL).parsed
+      end
+    end
+  end
+end

data/lib/omniauth-cz-shop-platforms.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'omniauth/cz_shop_platforms'

data/omniauth-cz-shop-platforms.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require File.expand_path(
+  File.join('..', 'lib', 'omniauth', 'cz_shop_platforms', 'version'),
+  __FILE__
+)
+
+Gem::Specification.new do |gem|
+  gem.name          = 'omniauth-cz-shop-platforms'
+  gem.version       = OmniAuth::CzShopPlatforms::VERSION
+  gem.license       = 'MIT'
+  gem.summary       = %(A collection of strategies for OmniAuth)
+  gem.description   = %(This allows you to login via multiple Czech e-commerce platforms with your ruby app.)
+  gem.authors       = ['Jan Sterba']
+  gem.email         = ['info@jansterba.com']
+  gem.homepage      = 'https://github.com/honzasterba/omniauth-cz-shop-platforms'
+
+  gem.files         = `git ls-files`.split("\n")
+  gem.require_paths = ['lib']
+
+  gem.required_ruby_version = '>= 2.7'
+
+  gem.add_runtime_dependency 'oauth2', '~> 1.1'
+  gem.add_runtime_dependency 'omniauth', '~> 2.0'
+  gem.add_runtime_dependency 'omniauth-oauth2', '~> 1.7.1'
+
+  gem.add_development_dependency 'rake', '~> 12.0'
+  gem.add_development_dependency 'rspec', '~> 3.6'
+  gem.add_development_dependency 'rubocop', '~> 0.49'
+end

data/spec/omniauth/strategies/web_areal_spec.rb

@@ -0,0 +1,170 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'json'
+require 'omniauth-cz-shop-platforms'
+require 'stringio'
+
+describe OmniAuth::Strategies::WebAreal do
+  let(:request) { double('Request', params: {}, cookies: {}, env: {}) }
+  let(:app) do
+    lambda do
+      [200, {}, ['Hello.']]
+    end
+  end
+
+  subject do
+    OmniAuth::Strategies::WebAreal.new(app, 'appid', 'secret', @options || {}).tap do |strategy|
+      allow(strategy).to receive(:request) do
+        request
+      end
+    end
+  end
+
+  before do
+    OmniAuth.config.test_mode = true
+  end
+
+  after do
+    OmniAuth.config.test_mode = false
+  end
+
+  describe '#client_options' do
+    it 'has correct site' do
+      expect(subject.client.site).to eq('https://marketplace.webareal.cz')
+    end
+
+    it 'has correct authorize_url' do
+      expect(subject.client.options[:authorize_url]).to eq('/user-auth')
+    end
+
+    it 'has correct token_url' do
+      expect(subject.client.options[:token_url]).to eq('/api/token')
+    end
+
+    describe 'overrides' do
+      context 'as strings' do
+        it 'should allow overriding the site' do
+          @options = { client_options: { 'site' => 'https://example.com' } }
+          expect(subject.client.site).to eq('https://example.com')
+        end
+
+        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
+
+      context 'as symbols' do
+        it 'should allow overriding the site' do
+          @options = { client_options: { site: 'https://example.com' } }
+          expect(subject.client.site).to eq('https://example.com')
+        end
+
+        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_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' }
+      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_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/rubocop_spec.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative 'spec_helper'
+
+describe 'Rubocop' do
+  it 'should pass with no offenses detected' do
+    expect(`rubocop`).to include('no offenses detected')
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require File.join('bundler', 'setup')
+require 'rspec'

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-cz-shop-platforms
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jan Sterba
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-03-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: omniauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.49'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.49'
+description: This allows you to login via multiple Czech e-commerce platforms with
+  your ruby app.
+email:
+- info@jansterba.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/publish-gem.sh
+- lib/omniauth-cz-shop-platforms.rb
+- lib/omniauth/cz_shop_platforms.rb
+- lib/omniauth/cz_shop_platforms/version.rb
+- lib/omniauth/strategies/web_areal.rb
+- omniauth-cz-shop-platforms.gemspec
+- spec/omniauth/strategies/web_areal_spec.rb
+- spec/rubocop_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/honzasterba/omniauth-cz-shop-platforms
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: A collection of strategies for OmniAuth
+test_files: []