cgi_party 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a97167288228a134bb92d9d3ad1cbc28690b2d1b
+  data.tar.gz: eff0aa5f12900a09f082ee6424b7a1769bbe3bc5
+SHA512:
+  metadata.gz: 6e7cac639147e60ca5ac2ed718d302d238d71b88d7e81404d3187c7d475b60ef127da4d9b448ed708be338984f02c5349340f29e6634eed36c26c323f207b93d
+  data.tar.gz: ea178ab86e66ab2fc0c63bf8b1201c1527cbbb73a20196dc504024d7965eaa68eb12766f58ce98ef902c258854d898e0c2fcefff61ed33c7d62eae2b4b2f2232

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.5
+before_install: gem install bundler -v 1.16.0

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in cgi_party.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,70 @@
+PATH
+  remote: .
+  specs:
+    cgi_party (0.1.0)
+      savon (~> 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    akami (1.3.1)
+      gyoku (>= 0.4.0)
+      nokogiri
+    builder (3.2.3)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    gyoku (1.3.1)
+      builder (>= 2.1.2)
+    httpi (2.4.2)
+      rack
+      socksify
+    method_source (0.9.0)
+    mini_portile2 (2.3.0)
+    nokogiri (1.8.2)
+      mini_portile2 (~> 2.3.0)
+    nori (2.6.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rack (2.0.4)
+    rake (10.4.2)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+    savon (2.12.0)
+      akami (~> 1.2)
+      builder (>= 2.1.2)
+      gyoku (~> 1.2)
+      httpi (~> 2.3)
+      nokogiri (>= 1.8.1)
+      nori (~> 2.4)
+      wasabi (~> 3.4)
+    socksify (1.7.1)
+    timecop (0.9.1)
+    wasabi (3.5.0)
+      httpi (~> 2.0)
+      nokogiri (>= 1.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  cgi_party!
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  timecop
+
+BUNDLED WITH
+   1.16.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Emric
+
+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,110 @@
+# CGIParty
+CGIParty is a gem made for integrating against the CGI Group GRP API.
+As of now you can only perform BankID authorisation.
+
+- *You will need an agreement with CGI group in order to user their API. We do not provide this.*
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cgi_party'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cgi_party
+
+### Configuration
+To use the gem you must configure some settings.
+Here is the settings available:
+```ruby
+CGIParty.configure do |config|
+  # (Optional) The number of seconds a poll operation will be active before timeout. Recommended is 180 seconds.
+  config.collect_polling_timeout = 180
+
+  # (Optional) The number of seconds a poll operation will wait between each call. Recommended is 3 seconds.
+  config.collect_polling_delay = 3
+
+  # (Optional) The path where the WSDL is located. Change to CGIParty::WSDL_TEST_PATH in development and testing
+  config.wsdl_path = CGIParty::WSDL_PATH
+
+  # (Required) The name that will be displayed in the BankID app. "Jag legitimerar mig mot #{display_name}"
+  config.display_name = "display_name"
+
+  # (Required) An identifier for your service provided by the CGI Group
+  config.service_id = "service_id"
+end
+```
+
+## Usage
+Before doing any consecutive requests you must first initiate a client and call
+the authenticate method. The authenticate response will contain information about
+the authentication order.
+```ruby
+client = CGIParty::Client.new
+authenticate_response = client.authenticate(social_security_number)
+```
+
+You can acquire an url for prompting the BankID application on the device.
+```ruby
+authenticate_response.autostart_url(return_url)
+#=> "bankid:///?autostarttoken=[token]&redirect=[return_url]"
+```
+
+To poll the collect action you can use the poll collect method. The block will be yielded
+every time the API responds. You can take appropriate action in your application by using the provided
+progress statuses.
+
+You can read more about them in the CGI Group GRP API documentation:
+https://www.cgi.se/sites/default/files/files_se/pdf/grp_api.pdf
+```ruby
+client.poll_collect(authenticate_response.order_ref,
+                    authenticate_response.transaction_id) do |collect_response|
+  case collect_response.progress_status
+  when "OUTSTANDING_TRANSACTION"    # Awaiting BankID application to start. (Might need manual boot)
+  when "EXPIRED_TRANSACTION"        # No activity from the user after 180s.
+  when "ALREADY_IN_PROGRESS"        # An order for the user is already in progress.
+  when "INVALID_PARAMETERS"         # Invalid parameters provided.
+  when "ACCESS_DENIED_RP"           # Internal access problem. Contact CGI.
+  when "CERTIFICATE_ERR"            # The users BankID are revoked or invalid.
+  when "INTERNAL_ERROR"             # An internal BankID error occured.
+  when "START_FAILED"               # BankID client did't start after 30s
+  when "USER_CANCEL"                # The order was canceled by the user.
+  when "CLIENT_ERR"                 # An internal BankID error occurred.
+  when "CANCELLED"                  # The order was cancelled.
+  when "NO_CLIENT"                  # Users BankID was not available
+  when "COMPLETE"                   # The authentication is completed
+  when "RETRY"                      # A temporary error has occurred. Prompt the user to try again.
+  end
+end
+```
+
+A successful collect response will contain attributes about the authenticated person.
+```ruby
+collect_response.attributes
+#=>
+[
+  { name: "cn", value: "Bob Basil" },
+  { name: "serialnumber", value: "680916-1794" },
+  # ...
+]
+```
+
+## Development and testing
+When testing the functionality against the API it is preferable to not use
+the real endpoints. By changing the `wsdl_path` config variable in testing you can
+change all requests to enpoints made for testing.
+```ruby
+CGIParty.configure do |config|
+  config.wsdl_path = CGIParty::WSDL_TEST_PATH
+  # ...
+end
+```
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "cgi_party"
+
+# 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(__FILE__)

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/cgi_party.gemspec

@@ -0,0 +1,39 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "cgi_party/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "cgi_party"
+  spec.version       = CGIParty::VERSION
+  spec.authors       = ["Emric"]
+  spec.email         = ["w.e.w@live.se"]
+
+  spec.summary       = %q{Makes CGI Group GRP integration a party! <3}
+  spec.homepage      = "https://github.com/standout/cgi-party"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  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.add_dependency "savon", "~> 2.0"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "timecop"
+end

data/lib/cgi_party/authenticate_request.rb

@@ -0,0 +1,32 @@
+require "cgi_party/authenticate_response"
+require "cgi_party/request"
+
+module CGIParty
+  class AuthenticateRequest < CGIParty::Request
+    attr_reader :service_id, :display_name, :provider, :ssn
+
+    def initialize(savon_client, ssn, options: {})
+      super(savon_client, options)
+      @ssn = ssn
+    end
+
+    private
+
+    def available_options
+      %i[display_name provider service_id]
+    end
+
+    def serialize_data(data)
+      CGIParty::AuthenticateResponse.new(data)
+    end
+
+    def message_hash
+      {
+        display_name: @options[:display_name],
+        provider: @options[:provider],
+        policy: @options[:service_id],
+        personal_number: @ssn
+      }
+    end
+  end
+end

data/lib/cgi_party/authenticate_response.rb

@@ -0,0 +1,9 @@
+require "cgi_party/response"
+
+module CGIParty
+  class AuthenticateResponse < Response
+    def autostart_url(return_url)
+      "bankid:///?autostarttoken=#{auto_start_token}&redirect=#{return_url}"
+    end
+  end
+end

data/lib/cgi_party/client.rb

@@ -0,0 +1,51 @@
+require "savon"
+
+
+module CGIParty
+  class Client
+    attr_reader :savon_client, :collect_responses, :polling_started_at
+
+    def initialize
+      @savon_client = Savon.client(savon_opts)
+    end
+
+    def poll_collect(order_ref, transaction_id = nil)
+      @polling_started_at = Time.now
+      loop do
+        collect_response = collect(order_ref, transaction_id)
+        return collect_response if timeout_polling?
+        yield(collect_response)
+        return collect_response if collect_response.authentication_finished?
+        sleep(CGIParty.config.collect_polling_delay)
+      end
+    end
+
+    def polling_duration
+      Time.now - @polling_started_at
+    end
+
+    def authenticate(ssn, options: {})
+      CGIParty::AuthenticateRequest.new(@savon_client, ssn).execute
+    end
+
+    def collect(order_reference, transaction_id, options: {})
+      CGIParty::CollectRequest.new(@savon_client, order_reference, transaction_id).execute
+    end
+
+    private
+
+    def timeout_polling?
+      polling_duration >= CGIParty.config.collect_polling_timeout
+    end
+
+    def savon_opts
+      {
+        namespace: CGIParty::WSDL_NAMESPACE,
+        namespace_identifier: :v1,
+        wsdl: CGIParty.config.wsdl_path,
+        env_namespace: :soapenv,
+        ssl_verify_mode: :none
+      }
+    end
+  end
+end

data/lib/cgi_party/collect_request.rb

@@ -0,0 +1,33 @@
+require "cgi_party/collect_response"
+require "cgi_party/request"
+
+module CGIParty
+  class CollectRequest < CGIParty::Request
+    attr_reader :order_reference, :transaction_id
+
+    def initialize(savon_client, order_reference, transaction_id = nil, options: {})
+      super(savon_client, options)
+      @order_reference = order_reference
+      @transaction_id = transaction_id
+    end
+
+    private
+
+    def serialize_data(data)
+      CGIParty::CollectResponse.new(data)
+    end
+
+    def available_options
+      %i[display_name service_id]
+    end
+
+    def message_hash
+      {
+        display_name: @options[:display_name],
+        policy: @options[:service_id],
+        transaction_id: @transaction_id,
+        order_ref: @order_reference
+      }
+    end
+  end
+end

data/lib/cgi_party/collect_response.rb

@@ -0,0 +1,19 @@
+require "cgi_party/response"
+
+module CGIParty
+  class CollectResponse < Response
+    def authentication_finished?
+      !authentication_ongoing?
+    end
+
+    def authentication_ongoing?
+      ongoing_statuses.include? progress_status
+    end
+
+    private
+
+    def ongoing_statuses
+      %w(OUTSTANDING_TRANSACTION USER_SIGN)
+    end
+  end
+end

data/lib/cgi_party/request.rb

@@ -0,0 +1,36 @@
+module CGIParty
+  class Request
+    def initialize(savon_client, options)
+      @options = fetch_options(options, available_options)
+      @savon_client = savon_client
+    end
+
+    def execute
+      serialize_data(
+        @savon_client.call(
+          action_name,
+          message: message_hash,
+          message_tag: message_tag
+        ).body
+      )
+    end
+
+    private
+
+    def fetch_options(options, available_options)
+      available_options.each do |option_name|
+        options[option_name] ||= CGIParty.config.public_send(option_name)
+      end
+      options
+    end
+
+    # Only works for single word actions
+    def action_name
+      message_tag[/(.*)(?:Request)/, 1].downcase.to_sym
+    end
+
+    def message_tag
+      self.class.name.gsub(/^.*::/, '')
+    end
+  end
+end

data/lib/cgi_party/response.rb

@@ -0,0 +1,28 @@
+module CGIParty
+  class Response
+    attr_reader :received_at
+
+    def initialize(source_data)
+      @source_data = source_data
+      @received_at = Time.now
+    end
+
+    def method_missing(method_name, *args, &block)
+      fetch_value(method_name) || super
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      key_present?(method_name) || super
+    end
+
+    private
+
+    def fetch_value(key)
+      @source_data.values.first.fetch(key.to_sym, nil)
+    end
+
+    def key_present?(key)
+      @source_data.values.first.key?(key)
+    end
+  end
+end

data/lib/cgi_party/version.rb

@@ -0,0 +1,3 @@
+module CGIParty
+  VERSION = "0.1.0"
+end

data/lib/cgi_party/wsdl_paths.rb

@@ -0,0 +1,5 @@
+module CGIParty
+  WSDL_PATH = "https://grp.funktionstjanster.se:8890/grp/v1?wsdl"
+  WSDL_TEST_PATH = "https://grpt.funktionstjanster.se:18898/grp/v1?wsdl"
+  WSDL_NAMESPACE = "http://funktionstjanster.se/grp/service/v1.0.0/"
+end

data/lib/cgi_party.rb

@@ -0,0 +1,32 @@
+require "cgi_party/authenticate_request"
+require "cgi_party/collect_request"
+require "cgi_party/wsdl_paths"
+require "cgi_party/version"
+require "cgi_party/client"
+
+module CGIParty
+  class << self
+    attr_accessor :config
+  end
+
+  def self.configure
+    self.config ||= Configuration.new
+    yield(config)
+  end
+
+  class Configuration
+    attr_accessor :collect_polling_timeout
+    attr_accessor :collect_polling_delay
+    attr_accessor :display_name
+    attr_accessor :service_id
+    attr_accessor :wsdl_path
+    attr_reader   :provider
+
+    def initialize
+      @collect_polling_timeout = 180
+      @collect_polling_delay = 3
+      @wsdl_path = WSDL_PATH
+      @provider = "bankid"
+    end
+  end
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: cgi_party
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Emric
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: savon
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- w.e.w@live.se
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cgi_party.gemspec
+- lib/cgi_party.rb
+- lib/cgi_party/authenticate_request.rb
+- lib/cgi_party/authenticate_response.rb
+- lib/cgi_party/client.rb
+- lib/cgi_party/collect_request.rb
+- lib/cgi_party/collect_response.rb
+- lib/cgi_party/request.rb
+- lib/cgi_party/response.rb
+- lib/cgi_party/version.rb
+- lib/cgi_party/wsdl_paths.rb
+homepage: https://github.com/standout/cgi-party
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Makes CGI Group GRP integration a party! <3
+test_files: []