campact_user_service 2.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 214a865845390e44559c068f95a74ad8a85a46ff83eb5192edcc8e0b4f39440d
+  data.tar.gz: 7b2664936fec33426d6807f114a7820cb34455d5d9e2278fd017f14b13c720f9
+SHA512:
+  metadata.gz: 362b5d1d2735112327bb6b1f4c4d3137a719c565af5e37ef81bbf58958ea57400f9753c69b6132513a56bcd6639a1c0a565b84d28eda48833602cd2265bd6490
+  data.tar.gz: 8ea75a760589072fb567c3548f0b147f5420477ebbfae0009cf31614af365d3982c485b77857ead0af601df814c182d75a105056a65f8e0fa38d160f8e8a6493

data/.ruby-gemset

@@ -0,0 +1 @@
+campact-user-service

data/.ruby-version

@@ -0,0 +1 @@
+2.5.3

data/Gemfile

@@ -0,0 +1,19 @@
+source "https://rubygems.org"
+
+gem 'base32', '~> 0.3.2'
+gem 'rotp', '~> 3.3', '>= 3.3.1'
+gem 'faraday', '>= 0.12.2', '< 1.0'
+gem 'json', '~> 2.1'
+
+group :development do
+  gem 'byebug', '>= 0'
+  gem 'rspec', '>= 0'
+  gem 'shoulda', '>= 0'
+  gem 'webmock', '>= 0'
+  gem 'rdoc', '~> 6.0', '>= 6.0.4'
+  gem 'bundler', '~> 1.16', '>= 1.16.2'
+  gem 'juwelier', '~> 2.4', '>= 2.4.9'
+  gem 'simplecov', '= 0.16.1'
+  gem 'pry-byebug', '~> 3.6'
+  gem 'faraday-detailed_logger', '~> 2.1', '>= 2.1.2'
+end

data/LICENSE

@@ -0,0 +1,10 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 ControlShift
+
+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,6 @@
+# campact-user-service
+a ruby gem that wraps the Campact user service API
+
+## License
+
+MIT. See [LICENSE](LICENSE) for details.

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'juwelier'
+Juwelier::Tasks.new do |gem|
+  gem.name = "campact_user_service"
+  gem.homepage = "http://github.com/controlshift/campact_user_service"
+  gem.license = "MIT"
+  gem.summary = %Q{Ruby wrapper for Campact User Service}
+  gem.description = %Q{Ruby wrapper for Campact User Service}
+  gem.email = "hello@controlshiftlabs.com"
+  gem.authors = ["ControlShift"]
+
+  # dependencies defined in Gemfile
+end
+Juwelier::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "krautbuster_api #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+2.0.1

data/campact_user_service.gemspec

@@ -0,0 +1,98 @@
+# Generated by juwelier
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: campact_user_service 2.0.1 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "campact_user_service".freeze
+  s.version = "2.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib".freeze]
+  s.authors = ["ControlShift".freeze]
+  s.date = "2019-08-12"
+  s.description = "Ruby wrapper for Campact User Service".freeze
+  s.email = "hello@controlshiftlabs.com".freeze
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.md"
+  ]
+  s.files = [
+    ".ruby-gemset",
+    ".ruby-version",
+    "Gemfile",
+    "LICENSE",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "campact_user_service.gemspec",
+    "example.rb",
+    "lib/campact_user_service.rb",
+    "lib/campact_user_service/account.rb",
+    "lib/campact_user_service/client.rb",
+    "lib/campact_user_service/response_error.rb",
+    "lib/campact_user_service/session.rb",
+    "spec/account_spec.rb",
+    "spec/campact_user_service_spec.rb",
+    "spec/client_spec.rb",
+    "spec/session_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/controlshift/campact_user_service".freeze
+  s.licenses = ["MIT".freeze]
+  s.rubygems_version = "3.0.3".freeze
+  s.summary = "Ruby wrapper for Campact User Service".freeze
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<base32>.freeze, ["~> 0.3.2"])
+      s.add_runtime_dependency(%q<rotp>.freeze, ["~> 3.3", ">= 3.3.1"])
+      s.add_runtime_dependency(%q<faraday>.freeze, [">= 0.12.2", "< 1.0"])
+      s.add_runtime_dependency(%q<json>.freeze, ["~> 2.1"])
+      s.add_development_dependency(%q<byebug>.freeze, [">= 0"])
+      s.add_development_dependency(%q<rspec>.freeze, [">= 0"])
+      s.add_development_dependency(%q<shoulda>.freeze, [">= 0"])
+      s.add_development_dependency(%q<webmock>.freeze, [">= 0"])
+      s.add_development_dependency(%q<rdoc>.freeze, ["~> 6.0", ">= 6.0.4"])
+      s.add_development_dependency(%q<bundler>.freeze, ["~> 1.16", ">= 1.16.2"])
+      s.add_development_dependency(%q<juwelier>.freeze, ["~> 2.4", ">= 2.4.9"])
+      s.add_development_dependency(%q<simplecov>.freeze, ["= 0.16.1"])
+      s.add_development_dependency(%q<pry-byebug>.freeze, ["~> 3.6"])
+      s.add_development_dependency(%q<faraday-detailed_logger>.freeze, ["~> 2.1", ">= 2.1.2"])
+    else
+      s.add_dependency(%q<base32>.freeze, ["~> 0.3.2"])
+      s.add_dependency(%q<rotp>.freeze, ["~> 3.3", ">= 3.3.1"])
+      s.add_dependency(%q<faraday>.freeze, [">= 0.12.2", "< 1.0"])
+      s.add_dependency(%q<json>.freeze, ["~> 2.1"])
+      s.add_dependency(%q<byebug>.freeze, [">= 0"])
+      s.add_dependency(%q<rspec>.freeze, [">= 0"])
+      s.add_dependency(%q<shoulda>.freeze, [">= 0"])
+      s.add_dependency(%q<webmock>.freeze, [">= 0"])
+      s.add_dependency(%q<rdoc>.freeze, ["~> 6.0", ">= 6.0.4"])
+      s.add_dependency(%q<bundler>.freeze, ["~> 1.16", ">= 1.16.2"])
+      s.add_dependency(%q<juwelier>.freeze, ["~> 2.4", ">= 2.4.9"])
+      s.add_dependency(%q<simplecov>.freeze, ["= 0.16.1"])
+      s.add_dependency(%q<pry-byebug>.freeze, ["~> 3.6"])
+      s.add_dependency(%q<faraday-detailed_logger>.freeze, ["~> 2.1", ">= 2.1.2"])
+    end
+  else
+    s.add_dependency(%q<base32>.freeze, ["~> 0.3.2"])
+    s.add_dependency(%q<rotp>.freeze, ["~> 3.3", ">= 3.3.1"])
+    s.add_dependency(%q<faraday>.freeze, [">= 0.12.2", "< 1.0"])
+    s.add_dependency(%q<json>.freeze, ["~> 2.1"])
+    s.add_dependency(%q<byebug>.freeze, [">= 0"])
+    s.add_dependency(%q<rspec>.freeze, [">= 0"])
+    s.add_dependency(%q<shoulda>.freeze, [">= 0"])
+    s.add_dependency(%q<webmock>.freeze, [">= 0"])
+    s.add_dependency(%q<rdoc>.freeze, ["~> 6.0", ">= 6.0.4"])
+    s.add_dependency(%q<bundler>.freeze, ["~> 1.16", ">= 1.16.2"])
+    s.add_dependency(%q<juwelier>.freeze, ["~> 2.4", ">= 2.4.9"])
+    s.add_dependency(%q<simplecov>.freeze, ["= 0.16.1"])
+    s.add_dependency(%q<pry-byebug>.freeze, ["~> 3.6"])
+    s.add_dependency(%q<faraday-detailed_logger>.freeze, ["~> 2.1", ">= 2.1.2"])
+  end
+end
+

data/example.rb

@@ -0,0 +1,80 @@
+$LOAD_PATH << File.join(File.dirname(__FILE__), 'lib')
+
+require 'campact_user_service'
+require 'faraday/detailed_logger'
+
+def instrument_connection_with_extended_logging(client, username, password)
+  default_options = {
+    ssl: { verify: true },
+    headers: {
+      'Accept' => "application/json;q=0.1",
+      'Accept-Charset' => "utf-8",
+      'User-Agent' => 'campact_user_service'
+    }
+  }
+
+  faraday_builder = ->(faraday) do
+    faraday.response :detailed_logger
+    faraday.basic_auth username, password
+    faraday.adapter Faraday.default_adapter
+  end
+
+  instrumented_connection = Faraday.new(
+    "#{client.scheme}://#{client.host}:#{client.port}",
+    default_options,
+    &faraday_builder
+  )
+  client.instance_variable_set(:@connection, instrumented_connection)
+end
+
+# Pick which API to connect to
+# 1 for session
+# 2 for user
+puts "Which user service are you going to use?\n\t1) session\n\t2) user"
+option = gets.chomp
+
+# Get username
+puts "I'll need your API credentials"
+puts "Enter your API username"
+username = gets.chomp
+
+# Get password
+puts "I'll need your password now"
+password = gets.chomp
+
+# Now connect to the right API
+user_service = case option
+when '1'
+  puts "Now I'll need a session token"
+  token = gets.chomp
+  session = CampactUserService.session(
+    token,
+    'campact-demo-session',
+    {
+      scheme: 'http',
+      host: 'demo.campact.de',
+      port: '10004'
+    }
+  )
+when '2'
+  puts "I'll need a user ID (email address). In practice I won't need this here because it can be derived through the session token"
+  user_id = gets.chomp
+  account = CampactUserService.account(
+    user_id,
+    {
+      scheme: 'http',
+      host: 'demo.campact.de',
+      port: '10003'
+    }
+  )
+else
+  raise 'Invalid option'
+end
+
+instrument_connection_with_extended_logging(user_service.client, username, password)
+
+puts "Waiting for your command..."
+require 'pry-byebug'
+binding.pry
+
+puts 'Goodbye!'

data/lib/campact_user_service.rb

@@ -0,0 +1,17 @@
+require 'campact_user_service/client'
+require 'campact_user_service/session'
+require 'campact_user_service/account'
+
+module CampactUserService
+  class << self
+    def session(session_id, session_cookie_name, options)
+      client = CampactUserService::Client.new(options)
+      CampactUserService::Session.new(client, session_id, session_cookie_name)
+    end
+
+    def account(user_id, options)
+      client = CampactUserService::Client.new(options)
+      CampactUserService::Account.new(client, user_id)
+    end
+  end
+end

data/lib/campact_user_service/account.rb

@@ -0,0 +1,51 @@
+module CampactUserService
+  class Account
+    attr_reader :client, :user_id
+
+    def initialize(client, user_id)
+      @client = client
+      @user_id = user_id
+    end
+
+    def exists?
+      account && account["id"]
+    end
+
+    def subscribed_to_newsletter?
+      subscriptions = account.dig('emailaddress', 'subscriptions') || []
+      subscriptions.any? {|s| s['type'] == 'newsletter' }
+    end
+
+    def allow_prefill?
+      prefill = account.dig('preferences', 'prefill_forms')
+      prefill.to_s == 'allowed'
+    end
+
+    def name
+      account['name']
+    end
+
+    def email
+      account.dig('emailaddress', 'emailaddress')
+    end
+
+    def address
+      account['postaladdress']
+    end
+
+    def preferences
+      account['preferences']
+    end
+
+    def donor_info
+      account['donorclass']
+    end
+
+    private
+
+    def account
+      escaped_user_id = CGI.escape(user_id)
+      @account_info ||= (client.get_request("api/v1/accounts/#{escaped_user_id}") || {})
+    end
+  end
+end

data/lib/campact_user_service/client.rb

@@ -0,0 +1,90 @@
+require 'faraday'
+require 'json'
+require 'base32'
+require 'rotp'
+require 'campact_user_service/response_error'
+
+module CampactUserService
+  class Client
+    TIMEOUT = 5.freeze
+
+    attr_reader :connection, :scheme, :host, :port
+
+    def initialize(options)
+      @scheme = options.fetch(:scheme, 'https')
+      @host = options.fetch(:host)
+      @port = options[:port]
+      faraday_options = default_faraday_options.merge(options.delete(:faraday) || {})
+      adapter = faraday_options.delete(:adapter) || Faraday.default_adapter
+
+      @connection = Faraday.new(endpoint, faraday_options) do |faraday|
+        if options.has_key?(:enable_auth)
+          faraday.basic_auth options[:username], options[:password]
+        end
+        faraday.adapter adapter
+      end
+    end
+
+    %i(get delete).each do |verb|
+      define_method("#{verb}_request") do |path, options={}|
+        request(verb, path, options)
+      end
+    end
+
+    private
+
+    def request(verb, path, options)
+      response = connection.send(verb.to_sym) do |req|
+        req.url path
+        req.options.timeout = TIMEOUT
+        req.options.open_timeout = TIMEOUT
+        if options.has_key?(:cookies)
+          req.headers['Cookie'] = format_cookies(options[:cookies])
+        end
+      end
+
+      case response.status
+      when 200
+        body = (response.body.nil? || response.body == '') ? '{ }' : response.body
+        JSON.parse(body)
+      when 201..299
+        true
+      when 404
+        nil
+      when 300..599
+        raise ResponseError.new(response.status, response.body)
+      else
+        nil
+      end
+    end
+
+    def default_faraday_options
+      {
+        ssl: { verify: true },
+        headers: {
+          'Accept' => "application/json;q=0.1",
+          'Accept-Charset' => "utf-8",
+          'User-Agent' => 'campact_user_service'
+        }
+      }
+    end
+
+    def endpoint
+      endpoint = "#{scheme}://#{host}"
+      if !port.nil?
+        endpoint << ":#{port}"
+      end
+
+      endpoint
+    end
+
+    def format_cookies(cookies)
+      case cookies
+        when String
+          cookies
+        when Hash
+          cookies.map {|k,v| "#{k}=#{v};" }.join
+      end
+    end
+  end
+end

data/lib/campact_user_service/response_error.rb

@@ -0,0 +1,11 @@
+module CampactUserService
+  class ResponseError < StandardError
+    attr_reader :status_code, :body
+
+    def initialize(status_code, body)
+      super("Response error. Status code: #{status_code} - Body: #{body}")
+      @status_code = status_code
+      @body = body
+    end
+  end
+end

data/lib/campact_user_service/session.rb

@@ -0,0 +1,37 @@
+module CampactUserService
+  class Session
+    attr_reader :client, :session_cookie_name, :session_id
+
+    def initialize(client, session_id, session_cookie_name)
+      @client = client
+      @session_id = session_id
+      @session_cookie_name = session_cookie_name
+    end
+
+    def exists?
+      session && session['id']
+    end
+
+    def user_id
+      session["user_id"]
+    end
+
+    def has_soft_login_session?
+      session["permission_level"] == 'limited'
+    end
+
+    def has_hard_login_session?
+      session["permission_level"] == 'full'
+    end
+
+    def destroy
+      client.delete_request('/v1/sessions', cookies: {session_cookie_name => session_id})
+    end
+
+    private
+
+    def session
+      @session_info ||= (client.get_request('/v1/sessions', cookies: {session_cookie_name => session_id}) || {})
+    end
+  end
+end

data/spec/account_spec.rb

@@ -0,0 +1,198 @@
+require 'spec_helper'
+
+describe CampactUserService::Account do
+  let(:client) { CampactUserService::Client.new(host: 'test.com') }
+  let(:session_id) { '123456abcdef' }
+  let(:session_cookie_name) { 'cus-session' }
+  let(:user_id) { 'test@example.org' }
+
+  subject {
+    CampactUserService::Account.new(client, user_id)
+  }
+
+  before(:each) do
+    WebMock.disable_net_connect!
+  end
+
+  describe '#exists?' do
+    it 'should return true where a valid user object is returned' do
+      stub_request(:get, "https://test.com/api/v1/accounts/#{user_id}")
+        .to_return(body: {
+          "id": "id-123"
+        }.to_json)
+
+      expect(subject.exists?).to be_truthy
+    end
+
+    it 'should not return true where an invalid user object is returned' do
+      stub_request(:get, "https://test.com/api/v1/accounts/#{user_id}")
+        .to_return(body: {
+          "error": true
+        }.to_json)
+
+      expect(subject.exists?).to be_falsey
+    end
+  end
+
+  describe 'URI escaping' do
+    it 'should escape the user ID in any requests' do
+      malicious_user_id = "\11\15"
+      malicious_subject = CampactUserService::Account.new(
+        client,
+        malicious_user_id
+      )
+      stub_request(:get, "https://test.com/api/v1/accounts/%09%0D")
+        .to_return(body: '', status: 404)
+
+      expect(malicious_subject.exists?).to be_falsey
+    end
+
+    it 'should escape "/" characters' do
+      malicious_user_id = "foo@example.com/secrets"
+      malicious_subject = CampactUserService::Account.new(
+        client,
+        malicious_user_id
+      )
+      stub_request(:get, "https://test.com/api/v1/accounts/foo@example.com%2Fsecrets")
+        .to_return(body: '', status: 404)
+
+      expect(malicious_subject.exists?).to be_falsey
+    end
+  end
+
+  describe '#name' do
+    it 'should retrieve all of the names and gender of the user' do
+      stub_request(:get, "https://test.com/api/v1/accounts/#{user_id}")
+        .to_return(body: {
+          "name": {
+            "firstname": "Alice",
+            "lastname": "Wu",
+            "gender": "female",
+            "title": "PhD",
+            "fullname": "PhD Alice Wu"
+          },
+        }.to_json)
+
+      name = subject.name
+      expect(name['firstname']).to eq 'Alice'
+      expect(name['lastname']).to eq 'Wu'
+      expect(name['gender']).to eq 'female'
+      expect(name['title']).to eq 'PhD'
+      expect(name['fullname']).to eq 'PhD Alice Wu'
+    end
+  end
+
+  describe '#email' do
+    it 'should retrieve the email address of the user' do
+      stub_request(:get, "https://test.com/api/v1/accounts/#{user_id}")
+        .to_return(body: {
+          "emailaddress": {
+            "emailaddress": "foobar@example.com"
+          }
+        }.to_json)
+
+      email = subject.email
+      expect(email).to eq 'foobar@example.com'
+    end
+
+    it 'should return nil where no email address is set' do
+      stub_request(:get, "https://test.com/api/v1/accounts/#{user_id}")
+        .to_return(body: {
+          "emailaddress": {}
+        }.to_json)
+
+      email = subject.email
+      expect(email).to be_nil
+    end
+  end
+
+  describe '#address' do
+    it 'should retrieve the address of the user' do
+      stub_request(:get, "https://test.com/api/v1/accounts/#{user_id}")
+        .to_return(body: {
+          "postaladdress": {
+            "street": "123 Fake Street",
+            "postalcode": "E1234",
+            "locality": "London",
+            "countrycode": "GB"
+          }
+        }.to_json)
+
+      address = subject.address
+      expect(address['street']).to eq '123 Fake Street'
+    end
+  end
+
+  describe '#subscribed_to_newsletter?' do
+    it 'should be true where the user is subscribed' do
+      stub_request(:get, "https://test.com/api/v1/accounts/#{user_id}")
+        .to_return(body: {
+          "emailaddress": {
+            "emailaddress": "foobar@example.com",
+            "subscriptions": [{"type": "newsletter"}]
+          }
+        }.to_json)
+
+      expect(subject.subscribed_to_newsletter?).to be_truthy
+    end
+
+    it 'should be false where the user is not subscribed' do
+      stub_request(:get, "https://test.com/api/v1/accounts/#{user_id}")
+        .to_return(body: {
+          "emailaddress": {
+            "emailaddress": "foobar@example.com",
+            "subscriptions": []
+          }
+        }.to_json)
+
+      expect(subject.subscribed_to_newsletter?).to be_falsey
+    end
+
+    it 'should be false where user subscription is different than newsletter' do
+      stub_request(:get, "https://test.com/api/v1/accounts/#{user_id}")
+        .to_return(body: {
+          "emailaddress": {
+            "emailaddress": "foobar@example.com",
+            "subscriptions": [{"type": "foo"}]
+          }
+        }.to_json)
+
+      expect(subject.subscribed_to_newsletter?).to be_falsey
+    end
+  end
+
+  describe '#allow_prefill?' do
+    it 'should allow prefilling where the user has opted-in' do
+      stub_request(:get, "https://test.com/api/v1/accounts/#{user_id}")
+        .to_return(body: {
+          "preferences": {
+            "prefill_forms": "allowed"
+          }
+        }.to_json)
+
+      expect(subject.allow_prefill?).to be_truthy
+    end
+
+    it 'should not allow prefilling where the user has not decided' do
+      stub_request(:get, "https://test.com/api/v1/accounts/#{user_id}")
+        .to_return(body: {
+          "preferences": {
+            "prefill_forms": "undecided"
+          }
+        }.to_json)
+
+      expect(subject.allow_prefill?).to be_falsey
+    end
+
+    it 'should not allow prefilling where the user has opted out' do
+      stub_request(:get, "https://test.com/api/v1/accounts/#{user_id}")
+        .to_return(body: {
+          "preferences": {
+            "prefill_forms": "disallowed"
+          }
+        }.to_json)
+
+      expect(subject.allow_prefill?).to be_falsey
+    end
+  end
+end

data/spec/campact_user_service_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe CampactUserService do
+  subject { CampactUserService }
+
+  describe '.session' do
+    it 'should create Session instance with correct arguments' do
+      options = { foo: 'bar', foo2: 'bar2' }
+      client = double
+      expect(CampactUserService::Client).to receive(:new).with(options).and_return(client)
+      session_id = '123abcd'
+      session_cookie_name = 'campact-session'
+      session_api = double
+      expect(CampactUserService::Session).to receive(:new).with(client, session_id, session_cookie_name).and_return(session_api)
+
+      session = subject.session(session_id, session_cookie_name, options)
+
+      expect(session).to be(session_api)
+    end
+  end
+
+  describe '.account' do
+    it 'should create Account instance with correct arguments' do
+      options = { foo: 'bar', foo2: 'bar2' }
+      client = double
+      expect(CampactUserService::Client).to receive(:new).with(options).and_return(client)
+      user_id = 'test@example.com'
+      account_api = double
+      expect(CampactUserService::Account).to receive(:new).with(client, user_id).and_return(account_api)
+
+      account = subject.account(user_id, options)
+
+      expect(account).to be(account_api)
+    end
+  end
+end

data/spec/client_spec.rb

@@ -0,0 +1,161 @@
+require 'spec_helper'
+
+describe CampactUserService::Client do
+  describe 'initialization' do
+    let(:options) {
+      {
+        scheme: 'https',
+        host: 'demo.campact.de',
+        port: '10003',
+        faraday: { a_custom_option: 'foo', adapter: :an_adapter }
+      }
+    }
+    let(:faraday_builder) { double(adapter: true) }
+
+    it 'should initialize connection from options' do
+      expect(faraday_builder).to receive(:adapter).with(:an_adapter)
+
+      expect(Faraday).to receive(:new) do |endpoint, initialization_options|
+        expect(endpoint).to eq 'https://demo.campact.de:10003'
+        expect(initialization_options[:a_custom_option]).to eq 'foo'
+      end.and_yield(faraday_builder)
+
+      CampactUserService::Client.new(options)
+    end
+
+    it 'should use default faraday options for connection' do
+      expect(Faraday).to receive(:new) do |endpoint, initialization_options|
+        expect(initialization_options[:ssl][:verify]).to be_truthy
+        expect(initialization_options[:headers]['Accept']).to eq "application/json;q=0.1"
+        expect(initialization_options[:headers]['Accept-Charset']).to eq "utf-8"
+        expect(initialization_options[:headers]['User-Agent']).to eq 'campact_user_service'
+      end.and_yield(faraday_builder)
+
+      CampactUserService::Client.new(options)
+    end
+
+    it 'should allow overriding default options' do
+      options[:faraday][:ssl] = {verify: false}
+      options[:faraday][:headers] = {'Accept'=>'custom-accept-header', 'Accept-Charset'=>'custom-accept-charset-header', 'User-Agent'=>'custom-user-agent-header'}
+
+      expect(Faraday).to receive(:new) do |endpoint, initialization_options|
+        expect(initialization_options[:ssl][:verify]).to be_falsey
+        expect(initialization_options[:headers]['Accept']).to eq 'custom-accept-header'
+        expect(initialization_options[:headers]['Accept-Charset']).to eq 'custom-accept-charset-header'
+        expect(initialization_options[:headers]['User-Agent']).to eq 'custom-user-agent-header'
+      end.and_yield(faraday_builder)
+
+      CampactUserService::Client.new(options)
+    end
+  end
+
+  shared_examples 'error handling' do
+    [310, 410, 510].each do |unexpected_status_code|
+      it 'should raise error if status code is 3xx, 4xx or 5xx' do
+        expect(request_builder).to receive(:url).with('/foo/bar')
+        expect(request_builder_options).to receive(:timeout=).with(CampactUserService::Client::TIMEOUT)
+        expect(request_builder_options).to receive(:open_timeout=).with(CampactUserService::Client::TIMEOUT)
+        allow(response).to receive(:status).and_return(unexpected_status_code)
+        allow(response).to receive(:body).and_return('An error occurred')
+
+        expect { subject.send(method_under_test, '/foo/bar') }.to raise_error do |error|
+          expect(error).to be_an_instance_of CampactUserService::ResponseError
+          expect(error.status_code).to eq(unexpected_status_code)
+          expect(error.body).to eq('An error occurred')
+        end
+      end
+    end
+
+    it 'should return nil if status code is 404' do
+      expect(request_builder).to receive(:url).with('/foo/bar')
+      expect(request_builder_options).to receive(:timeout=).with(CampactUserService::Client::TIMEOUT)
+      expect(request_builder_options).to receive(:open_timeout=).with(CampactUserService::Client::TIMEOUT)
+      allow(response).to receive(:status).and_return(404)
+
+      response = subject.send(method_under_test, '/foo/bar')
+
+      expect(response).to be_nil
+    end
+  end
+
+  describe '#get_request' do
+    let(:connection) { double }
+    let(:request_builder) { double }
+    let(:request_builder_options) { double }
+    let(:response) { double(body: '') }
+    let(:method_under_test) { :get_request }
+
+    subject { CampactUserService::Client.new(host: 'demo.campact.de') }
+
+    before :each do
+      expect(Faraday).to receive(:new).and_yield(double(adapter: true)).and_return(connection)
+      expect(request_builder).to receive(:options).at_least(:once).and_return(request_builder_options)
+      expect(connection).to receive(:get).and_yield(request_builder).and_return(response)
+    end
+
+    include_examples 'error handling'
+
+    it 'should perform get request on provided path and return true if response is 204' do
+      expect(request_builder).to receive(:url).with('/foo/bar')
+      expect(request_builder_options).to receive(:timeout=).with(CampactUserService::Client::TIMEOUT)
+      expect(request_builder_options).to receive(:open_timeout=).with(CampactUserService::Client::TIMEOUT)
+      allow(response).to receive(:status).and_return(204)
+
+      expect(subject.get_request('/foo/bar')).to be_truthy
+    end
+
+    context 'stubbed request builder' do
+      let(:headers_builder) { double }
+
+      before :each do
+        allow(request_builder).to receive(:url).with('/foo/bar')
+        allow(request_builder_options).to receive(:timeout=).with(CampactUserService::Client::TIMEOUT)
+        allow(request_builder_options).to receive(:open_timeout=).with(CampactUserService::Client::TIMEOUT)
+        allow(request_builder).to receive(:headers).and_return(headers_builder)
+      end
+
+      it 'should set cookies sent as string' do
+        expect(headers_builder).to receive(:[]=).with('Cookie', 'foo=bar;xyz=abc')
+        allow(response).to receive(:status).and_return(200)
+
+        subject.get_request('/foo/bar', cookies: 'foo=bar;xyz=abc')
+      end
+
+      it 'should set cookies sent as hash' do
+        expect(headers_builder).to receive(:[]=).with('Cookie', 'foo=bar;xyz=abc;')
+        allow(response).to receive(:status).and_return(200)
+
+        subject.get_request('/foo/bar', cookies: {'foo' => 'bar', 'xyz' => 'abc'})
+      end
+
+      it 'should parse JSON response on successful response' do
+        allow(response).to receive(:status).and_return(200)
+        allow(response).to receive(:body).and_return({a_field: 'foo', another_field: 'bar'}.to_json)
+
+        response = subject.get_request('/foo/bar')
+
+        expect(response).not_to be_nil
+        expect(response['a_field']).to eq 'foo'
+        expect(response['another_field']).to eq 'bar'
+      end
+    end
+  end
+
+  describe '#delete_request' do
+    let(:connection) { double }
+    let(:request_builder) { double }
+    let(:request_builder_options) { double }
+    let(:response) { double(body: '') }
+    let(:method_under_test) { :delete_request }
+
+    subject { CampactUserService::Client.new(host: 'demo.campact.de') }
+
+    before :each do
+      expect(Faraday).to receive(:new).and_yield(double(adapter: true)).and_return(connection)
+      expect(request_builder).to receive(:options).at_least(:once).and_return(request_builder_options)
+      expect(connection).to receive(:delete).and_yield(request_builder).and_return(response)
+    end
+
+    include_examples 'error handling'
+  end
+end

data/spec/session_spec.rb

@@ -0,0 +1,83 @@
+require 'spec_helper'
+
+describe CampactUserService::Session do
+  let(:client) { CampactUserService::Client.new(host: 'test.com') }
+  let(:session_id) { '123456abcdef' }
+  let(:session_cookie_name) { 'cus-session' }
+
+  subject { CampactUserService::Session.new(client, session_id, session_cookie_name) }
+
+  describe '#exists?' do
+    it 'should be truthy when the session exists' do
+      stub_request(:get, 'https://test.com/v1/sessions')
+        .with(headers: {'Cookie' => "cus-session=#{session_id};"})
+        .to_return(body: {id: 'session-id'}.to_json)
+
+      expect(subject.exists?).to be_truthy
+    end
+
+    it "should be falsey when the session doesn't exist" do
+      stub_request(:get, 'https://test.com/v1/sessions')
+        .with(headers: {'Cookie' => "cus-session=#{session_id};"})
+        .to_return(body: '', status: 404)
+
+      expect(subject.exists?).to be_falsey
+    end
+  end
+
+  describe '#user_id' do
+    it 'should be present' do
+      stub_request(:get, 'https://test.com/v1/sessions')
+        .with(headers: {'Cookie' => "cus-session=#{session_id};"})
+        .to_return(body: {user_id: 'user@example.org'}.to_json)
+
+      expect(subject.user_id).to eq('user@example.org')
+    end
+  end
+
+  describe '#has_soft_login_session?' do
+    it 'should be true where permission level is limited' do
+      stub_request(:get, 'https://test.com/v1/sessions')
+        .with(headers: {'Cookie' => "cus-session=#{session_id};"})
+        .to_return(body: {permission_level: 'limited'}.to_json)
+
+      expect(subject.has_soft_login_session?).to be_truthy
+    end
+
+    it 'should be false where permission level is full' do
+      stub_request(:get, 'https://test.com/v1/sessions')
+        .with(headers: {'Cookie' => "cus-session=#{session_id};"})
+        .to_return(body: {permission_level: 'full'}.to_json)
+
+      expect(subject.has_soft_login_session?).to be_falsey
+    end
+  end
+
+  describe '#has_hard_login_session?' do
+    it 'should be true where permission level is full' do
+      stub_request(:get, 'https://test.com/v1/sessions')
+        .with(headers: {'Cookie' => "cus-session=#{session_id};"})
+        .to_return(body: {permission_level: 'full'}.to_json)
+
+      expect(subject.has_hard_login_session?).to be_truthy
+    end
+
+    it 'should be false where permission level is limited' do
+      stub_request(:get, 'https://test.com/v1/sessions')
+        .with(headers: {'Cookie' => "cus-session=#{session_id};"})
+        .to_return(body: {permission_level: 'limited'}.to_json)
+
+      expect(subject.has_hard_login_session?).to be_falsey
+    end
+  end
+
+  describe '#destroy' do
+    it 'should perform DELETE request' do
+      stub_request(:delete, 'https://test.com/v1/sessions')
+        .with(headers: {'Cookie' => "cus-session=#{session_id};"})
+        .to_return(body: '', status: 204)
+
+      expect(subject.destroy).to be_truthy
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'webmock/rspec'
+require 'campact_user_service'
+
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  config.include WebMock::API
+
+  config.before(:each) do
+    WebMock.reset!
+  end
+  config.after(:each) do
+    WebMock.reset!
+  end
+end

metadata

@@ -0,0 +1,295 @@
+--- !ruby/object:Gem::Specification
+name: campact_user_service
+version: !ruby/object:Gem::Version
+  version: 2.0.1
+platform: ruby
+authors:
+- ControlShift
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-08-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: base32
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.2
+- !ruby/object:Gem::Dependency
+  name: rotp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.1
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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: rspec
+  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: shoulda
+  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: webmock
+  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: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.4
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.16.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.16.2
+- !ruby/object:Gem::Dependency
+  name: juwelier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.4.9
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.4.9
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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: faraday-detailed_logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.2
+description: Ruby wrapper for Campact User Service
+email: hello@controlshiftlabs.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+files:
+- ".ruby-gemset"
+- ".ruby-version"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- campact_user_service.gemspec
+- example.rb
+- lib/campact_user_service.rb
+- lib/campact_user_service/account.rb
+- lib/campact_user_service/client.rb
+- lib/campact_user_service/response_error.rb
+- lib/campact_user_service/session.rb
+- spec/account_spec.rb
+- spec/campact_user_service_spec.rb
+- spec/client_spec.rb
+- spec/session_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/controlshift/campact_user_service
+licenses:
+- MIT
+metadata: {}
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for Campact User Service
+test_files: []