campact_user_service 3.1.0 → 4.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a757abe1d7920da576a75ce549919398e63e7cbe7992eec550ea858c99f5df6b
-  data.tar.gz: 1630b643c70172e7b9b46e499cbda48a3bc5a78f257f45ad1cfd70f756feb1dd
+  metadata.gz: a813950b868ab9de779df0020484de1f71517510019c125ea9ffaeae04e7e344
+  data.tar.gz: c720805249381d4a86e067959a75f80b60d1e2e5aefc84962913fa529554189c
 SHA512:
-  metadata.gz: 2b0bd9826a3cd73a03c22de64243f78261704fabc09bc581540614dfb45bd3fb37c77aa020d5f07ee490027a27d669175da6d94165feb9e22210551129ec9a17
-  data.tar.gz: 49b9d38cb242dd0ed249bf88493dea4f23d0fe0b1ba4b651d568db6d53725439e9ec9bc5fd7e3f98bbd86afaa1c3fcf1b3829c657c1bd350c827c52b07d9ba40
+  metadata.gz: d6e053ab747cefe3d7126b34b300c7331b5f239d8d97950e373479fbf0d1586a1dfb5b7d0db38b29d3c91c23600468e97540adcbf9b3b6f89d3b4db5489677cf
+  data.tar.gz: 37b282c8a03e46686549d128124ad62550086b37a1927a737518424b21509ad9c369a5800c6c2d8c4cb002a8104c626d76c28d8ab27b98adf8005757876a1bd7

data/.github/workflows/ci.yml

@@ -0,0 +1,24 @@
+name: CI
+on: [push]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@477b21f02be01bcb8030d50f37cfec92bfa615b6
+        with:
+          ruby-version: 2.7
+          bundler-cache: true
+      - run: bundle install
+      - run: bundle exec rspec
+  rubocop:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@477b21f02be01bcb8030d50f37cfec92bfa615b6
+        with:
+          ruby-version: 2.7
+          bundler-cache: true
+      - run: bundle install
+      - run: bundle exec rubocop

data/.ruby-version

@@ -1 +1 @@
-2.6.6
+3.0.3

data/Gemfile

@@ -1,7 +1,7 @@
 source "https://rubygems.org"
 
 gem 'rotp', '~> 6'
-gem 'faraday', '>= 0.12.2', '< 1.0'
+gem 'faraday', '~> 1.0'
 gem 'json', '~> 2.1'
 
 group :development do

data/README.md

@@ -1,5 +1,5 @@
 # campact-user-service
-[![Build Status](https://travis-ci.org/controlshift/campact-user-service.svg?branch=master)](https://travis-ci.org/controlshift/campact-user-service)
+[![CI Status](https://github.com/controlshift/campact-user-service/actions/workflows/ci.yml/badge.svg)](https://github.com/controlshift/campact-user-service/actions/workflows/ci.yml)
 
 a ruby gem that wraps the Campact user service API
 

data/VERSION

@@ -1 +1 @@
-3.1.0
+4.1.1

data/campact_user_service.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: campact_user_service 3.0.1 ruby lib
+# stub: campact_user_service 4.1.1 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "campact_user_service".freeze
-  s.version = "3.1.0"
+  s.version = "4.1.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 = "2020-08-24"
+  s.date = "2022-02-04"
   s.description = "Ruby wrapper for Campact User Service".freeze
   s.email = "hello@controlshiftlabs.com".freeze
   s.extra_rdoc_files = [
@@ -19,10 +19,10 @@ Gem::Specification.new do |s|
     "README.md"
   ]
   s.files = [
+    ".github/workflows/ci.yml",
     ".rubocop.yml",
     ".ruby-gemset",
     ".ruby-version",
-    ".travis.yml",
     "Gemfile",
     "LICENSE",
     "README.md",
@@ -43,7 +43,7 @@ Gem::Specification.new do |s|
   ]
   s.homepage = "http://github.com/controlshift/campact_user_service".freeze
   s.licenses = ["MIT".freeze]
-  s.rubygems_version = "3.1.2".freeze
+  s.rubygems_version = "3.2.32".freeze
   s.summary = "Ruby wrapper for Campact User Service".freeze
 
   if s.respond_to? :specification_version then
@@ -52,7 +52,7 @@ Gem::Specification.new do |s|
 
   if s.respond_to? :add_runtime_dependency then
     s.add_runtime_dependency(%q<rotp>.freeze, ["~> 6"])
-    s.add_runtime_dependency(%q<faraday>.freeze, [">= 0.12.2", "< 1.0"])
+    s.add_runtime_dependency(%q<faraday>.freeze, ["~> 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"])
@@ -66,7 +66,7 @@ Gem::Specification.new do |s|
     s.add_development_dependency(%q<rubocop>.freeze, [">= 0"])
   else
     s.add_dependency(%q<rotp>.freeze, ["~> 6"])
-    s.add_dependency(%q<faraday>.freeze, [">= 0.12.2", "< 1.0"])
+    s.add_dependency(%q<faraday>.freeze, ["~> 1.0"])
     s.add_dependency(%q<json>.freeze, ["~> 2.1"])
     s.add_dependency(%q<byebug>.freeze, [">= 0"])
     s.add_dependency(%q<rspec>.freeze, [">= 0"])

data/example.rb

@@ -62,10 +62,10 @@ when '1'
     }
   )
 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
+  puts "I'll need a user account ID. In practice I won't need this here because it can be derived through the session token"
+  external_account_id = gets.chomp
   account = CampactUserService.account(
-    user_id,
+    external_account_id,
     {
       host: 'weact-adapter.staging.campact.de',
       topt_authorization: {user: username, secret: secret}

data/lib/campact_user_service/account.rb

@@ -2,6 +2,7 @@ module CampactUserService
   class Account
     attr_reader :client, :user_id
 
+    # user_id can either be the user's external_account_id or their email address
     def initialize(client, user_id)
       @client = client
       @user_id = user_id

data/lib/campact_user_service/client.rb

@@ -5,7 +5,8 @@ require 'campact_user_service/response_error'
 
 module CampactUserService
   class Client
-    TIMEOUT = 5.freeze
+    TIMEOUT = 60.freeze
+    OPEN_TIMEOUT = 20.freeze
 
     attr_reader :connection, :host, :port, :topt_authorization
 
@@ -33,7 +34,7 @@ module CampactUserService
       response = connection.send(verb.to_sym) do |req|
         req.url path
         req.options.timeout = TIMEOUT
-        req.options.open_timeout = TIMEOUT
+        req.options.open_timeout = OPEN_TIMEOUT
         if options.key?(:cookies)
           req.headers['Cookie'] = format_cookies(options[:cookies])
         end

data/lib/campact_user_service/session.rb

@@ -8,8 +8,8 @@ module CampactUserService
       @session_cookie_name = session_cookie_name
     end
 
-    def user_id
-      session["user_id"]
+    def external_account_id
+      session["external_account_id"]
     end
 
     def has_soft_login_session?

data/lib/campact_user_service.rb

@@ -9,9 +9,9 @@ module CampactUserService
       CampactUserService::Session.new(client, session_id, session_cookie_name)
     end
 
-    def account(user_id, options)
+    def account(external_account_id, options)
       client = CampactUserService::Client.new(options)
-      CampactUserService::Account.new(client, user_id)
+      CampactUserService::Account.new(client, external_account_id)
     end
   end
 end

data/spec/campact_user_service_spec.rb

@@ -24,11 +24,11 @@ describe CampactUserService do
       options = { foo: 'bar', foo2: 'bar2' }
       client = double
       expect(CampactUserService::Client).to receive(:new).with(options).and_return(client)
-      user_id = 'test@example.com'
+      external_account_id = '189b6864-d58a-4f49-8370-4ae0b854a40e'
       account_api = double
-      expect(CampactUserService::Account).to receive(:new).with(client, user_id).and_return(account_api)
+      expect(CampactUserService::Account).to receive(:new).with(client, external_account_id).and_return(account_api)
 
-      account = subject.account(user_id, options)
+      account = subject.account(external_account_id, options)
 
       expect(account).to be(account_api)
     end

data/spec/client_spec.rb

@@ -53,7 +53,7 @@ describe CampactUserService::Client do
       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)
+        expect(request_builder_options).to receive(:open_timeout=).with(CampactUserService::Client::OPEN_TIMEOUT)
         allow(response).to receive(:status).and_return(unexpected_status_code)
         allow(response).to receive(:body).and_return('An error occurred')
 
@@ -68,7 +68,7 @@ describe CampactUserService::Client do
     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)
+      expect(request_builder_options).to receive(:open_timeout=).with(CampactUserService::Client::OPEN_TIMEOUT)
       allow(response).to receive(:status).and_return(404)
 
       response = subject.send(method_under_test, '/foo/bar')
@@ -97,7 +97,7 @@ describe CampactUserService::Client do
     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)
+      expect(request_builder_options).to receive(:open_timeout=).with(CampactUserService::Client::OPEN_TIMEOUT)
       allow(response).to receive(:status).and_return(204)
 
       expect(subject.get_request('/foo/bar')).to be_truthy
@@ -109,7 +109,7 @@ describe CampactUserService::Client do
       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_options).to receive(:open_timeout=).with(CampactUserService::Client::OPEN_TIMEOUT)
         allow(request_builder).to receive(:headers).and_return(headers_builder)
       end
 

data/spec/session_spec.rb

@@ -7,13 +7,13 @@ describe CampactUserService::Session do
 
   subject { CampactUserService::Session.new(client, session_id, session_cookie_name) }
 
-  describe '#user_id' do
+  describe '#external_account_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)
+        .to_return(body: {external_account_id: '189b6864-d58a-4f49-8370-4ae0b854a40e'}.to_json)
 
-      expect(subject.user_id).to eq('user@example.org')
+      expect(subject.external_account_id).to eq('189b6864-d58a-4f49-8370-4ae0b854a40e')
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: campact_user_service
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 4.1.1
 platform: ruby
 authors:
 - ControlShift
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-24 00:00:00.000000000 Z
+date: 2022-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rotp
@@ -28,20 +28,14 @@ dependencies:
   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
@@ -218,10 +212,10 @@ extra_rdoc_files:
 - LICENSE
 - README.md
 files:
+- ".github/workflows/ci.yml"
 - ".rubocop.yml"
 - ".ruby-gemset"
 - ".ruby-version"
-- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -258,7 +252,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.2.32
 signing_key: 
 specification_version: 4
 summary: Ruby wrapper for Campact User Service

data/.travis.yml

@@ -1,9 +0,0 @@
-language: ruby
-rvm:
-  - 2.6
-cache: bundler
-before_install:
-  - gem install bundler
-script:
-  - bundle exec rspec
-  - bundle exec rubocop