campact_user_service 4.1.1 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a813950b868ab9de779df0020484de1f71517510019c125ea9ffaeae04e7e344
-  data.tar.gz: c720805249381d4a86e067959a75f80b60d1e2e5aefc84962913fa529554189c
+  metadata.gz: b3c869e577689bc02693578a97970bb9ccf80fff5dd4a63e9eb5c3f74af88e42
+  data.tar.gz: d1ce8aeed9c071623e1dd4f7e73537e5da4d00e1cd3cc8c41ade91f9d2486ecd
 SHA512:
-  metadata.gz: d6e053ab747cefe3d7126b34b300c7331b5f239d8d97950e373479fbf0d1586a1dfb5b7d0db38b29d3c91c23600468e97540adcbf9b3b6f89d3b4db5489677cf
-  data.tar.gz: 37b282c8a03e46686549d128124ad62550086b37a1927a737518424b21509ad9c369a5800c6c2d8c4cb002a8104c626d76c28d8ab27b98adf8005757876a1bd7
+  metadata.gz: ac327c6be12ae6933ab108aaafec45768f7c9bcbb59c0cb49ee57ee68a9ddcb759c410c05dbd4e3156ca45999e632bf62bbbd77445521240864257e8f772593a
+  data.tar.gz: 7499d6b23a4f275997e1354d8716913891cf35760c73976b48dec7bdd0f842c63582702f89e6b9638cf9f23c49273c9d8eba1e1e47ede79b5fc4d746e951cc7c

data/.github/workflows/ci.yml

@@ -6,9 +6,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-      - uses: ruby/setup-ruby@477b21f02be01bcb8030d50f37cfec92bfa615b6
+      - uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 2.7
+          ruby-version: 3.4
           bundler-cache: true
       - run: bundle install
       - run: bundle exec rspec
@@ -16,9 +16,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-      - uses: ruby/setup-ruby@477b21f02be01bcb8030d50f37cfec92bfa615b6
+      - uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 2.7
+          ruby-version: 3.4
           bundler-cache: true
       - run: bundle install
       - run: bundle exec rubocop

data/.ruby-version

@@ -1 +1 @@
-3.0.3
+3.4.5

data/VERSION

@@ -1 +1 @@
-4.1.1
+4.2.0

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 4.1.1 ruby lib
+# stub: campact_user_service 4.2.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "campact_user_service".freeze
-  s.version = "4.1.1"
+  s.version = "4.2.0".freeze
 
   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 = "2022-02-04"
+  s.date = "1980-01-02"
   s.description = "Ruby wrapper for Campact User Service".freeze
   s.email = "hello@controlshiftlabs.com".freeze
   s.extra_rdoc_files = [
@@ -33,51 +33,35 @@ Gem::Specification.new do |s|
     "lib/campact_user_service.rb",
     "lib/campact_user_service/account.rb",
     "lib/campact_user_service/client.rb",
+    "lib/campact_user_service/prefill_forms.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/prefill_forms_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.2.32".freeze
+  s.rubygems_version = "3.6.9".freeze
   s.summary = "Ruby wrapper for Campact User Service".freeze
 
-  if s.respond_to? :specification_version then
-    s.specification_version = 4
-  end
+  s.specification_version = 4
 
-  if s.respond_to? :add_runtime_dependency then
-    s.add_runtime_dependency(%q<rotp>.freeze, ["~> 6"])
-    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"])
-    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<juwelier>.freeze, [">= 0"])
-    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"])
-    s.add_development_dependency(%q<rubocop>.freeze, [">= 0"])
-  else
-    s.add_dependency(%q<rotp>.freeze, ["~> 6"])
-    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"])
-    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<juwelier>.freeze, [">= 0"])
-    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"])
-    s.add_dependency(%q<rubocop>.freeze, [">= 0"])
-  end
+  s.add_runtime_dependency(%q<rotp>.freeze, ["~> 6".freeze])
+  s.add_runtime_dependency(%q<faraday>.freeze, ["~> 1.0".freeze])
+  s.add_runtime_dependency(%q<json>.freeze, ["~> 2.1".freeze])
+  s.add_development_dependency(%q<byebug>.freeze, [">= 0".freeze])
+  s.add_development_dependency(%q<rspec>.freeze, [">= 0".freeze])
+  s.add_development_dependency(%q<shoulda>.freeze, [">= 0".freeze])
+  s.add_development_dependency(%q<webmock>.freeze, [">= 0".freeze])
+  s.add_development_dependency(%q<rdoc>.freeze, ["~> 6.0".freeze, ">= 6.0.4".freeze])
+  s.add_development_dependency(%q<juwelier>.freeze, [">= 0".freeze])
+  s.add_development_dependency(%q<simplecov>.freeze, ["= 0.16.1".freeze])
+  s.add_development_dependency(%q<pry-byebug>.freeze, ["~> 3.6".freeze])
+  s.add_development_dependency(%q<faraday-detailed_logger>.freeze, ["~> 2.1".freeze, ">= 2.1.2".freeze])
+  s.add_development_dependency(%q<rubocop>.freeze, [">= 0".freeze])
 end
 

data/example.rb

@@ -3,9 +3,11 @@ $LOAD_PATH << File.join(File.dirname(__FILE__), 'lib')
 require 'campact_user_service'
 require 'faraday/detailed_logger'
 
+service_host = ENV['SERVICE_HOST'] || 'weact-adapter.staging.campact.de'
+
 def instrument_connection_with_extended_logging(client)
   default_options = {
-    ssl: { verify: true },
+    ssl: { verify: false },
     headers: {
       'Accept' => "application/json;q=0.1",
       'Accept-Charset' => "utf-8",
@@ -29,7 +31,8 @@ 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"
+# 3 for prefill forms
+puts "Which user service are you going to use?\n\t1) session\n\t2) user\n\t3) prefill forms"
 option = gets.chomp
 
 # Get TOTP credentials
@@ -57,17 +60,25 @@ when '1'
     token,
     'campact-staging-session',
     {
-      host: 'weact-adapter.staging.campact.de',
+      host: service_host,
       topt_authorization: {user: username, secret: secret}
     }
   )
 when '2'
   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_id = gets.chomp
   account = CampactUserService.account(
-    external_account_id,
+    account_id,
     {
-      host: 'weact-adapter.staging.campact.de',
+      host: service_host,
+      topt_authorization: {user: username, secret: secret}
+    }
+  )
+when '3'
+  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"
+  account_id = gets.chomp
+  prefill_forms = CampactUserService.prefill_forms(account_id, {
+      host: service_host,
       topt_authorization: {user: username, secret: secret}
     }
   )

data/lib/campact_user_service/account.rb

@@ -2,7 +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
+    # user_id can either be the user's account_id or their email address
     def initialize(client, user_id)
       @client = client
       @user_id = user_id
@@ -17,8 +17,13 @@ module CampactUserService
       subscriptions.any? {|s| s['type'] == 'newsletter' }
     end
 
+    def prefill_undecided?
+      prefill = account['prefill_forms_state']
+      prefill.to_s == 'undecided'
+    end
+
     def allow_prefill?
-      prefill = account.dig('preferences', 'prefill_forms')
+      prefill = account['prefill_forms_state']
       prefill.to_s == 'allowed'
     end
 

data/lib/campact_user_service/client.rb

@@ -19,10 +19,11 @@ module CampactUserService
 
       @connection = Faraday.new(endpoint, faraday_options) do |faraday|
         faraday.adapter adapter
+        faraday.request :json
       end
     end
 
-    %i(get delete).each do |verb|
+    %i(get delete patch).each do |verb|
       define_method("#{verb}_request") do |path, options={}|
         request(verb, path, options)
       end
@@ -39,6 +40,10 @@ module CampactUserService
           req.headers['Cookie'] = format_cookies(options[:cookies])
         end
 
+        if options.key?(:body)
+          req.body = options[:body]
+        end
+
         if topt_authorization
           req.headers['authorization'] = authorization(topt_authorization)
         end

data/lib/campact_user_service/prefill_forms.rb

@@ -0,0 +1,24 @@
+require 'cgi'
+
+module CampactUserService
+  class PrefillForms
+    attr_reader :client, :account_id
+
+    def initialize(client, account_id)
+      @client = client
+      @account_id = account_id
+    end
+
+    def update_prefill_forms(prefill_forms_state:, campaign_slug:, **additional_params)
+      params = {
+        prefill_forms: {
+          state: prefill_forms_state,
+          slug: campaign_slug
+        }.merge(additional_params)
+      }
+
+      path = "/v1/prefill_forms?account_id=#{CGI.escape(account_id.to_s)}"
+      client.patch_request(path, body: params)
+    end
+  end
+end

data/lib/campact_user_service/session.rb

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

data/lib/campact_user_service.rb

@@ -1,6 +1,7 @@
 require 'campact_user_service/client'
 require 'campact_user_service/session'
 require 'campact_user_service/account'
+require 'campact_user_service/prefill_forms'
 
 module CampactUserService
   class << self
@@ -9,9 +10,14 @@ module CampactUserService
       CampactUserService::Session.new(client, session_id, session_cookie_name)
     end
 
-    def account(external_account_id, options)
+    def account(account_id, options)
       client = CampactUserService::Client.new(options)
-      CampactUserService::Account.new(client, external_account_id)
+      CampactUserService::Account.new(client, account_id)
+    end
+
+    def prefill_forms(account_id, options)
+      client = CampactUserService::Client.new(options)
+      CampactUserService::PrefillForms.new(client, account_id)
     end
   end
 end

data/spec/account_spec.rb

@@ -165,9 +165,7 @@ describe CampactUserService::Account do
     it 'should allow prefilling where the user has opted-in' do
       stub_request(:get, "https://test.com/v1/accounts/#{user_id}")
         .to_return(body: {
-          "preferences": {
-            "prefill_forms": "allowed"
-          }
+          "prefill_forms_state":  "allowed"
         }.to_json)
 
       expect(subject.allow_prefill?).to be_truthy
@@ -176,9 +174,7 @@ describe CampactUserService::Account do
     it 'should not allow prefilling where the user has not decided' do
       stub_request(:get, "https://test.com/v1/accounts/#{user_id}")
         .to_return(body: {
-          "preferences": {
-            "prefill_forms": "undecided"
-          }
+          "prefill_forms_state": "undecided"
         }.to_json)
 
       expect(subject.allow_prefill?).to be_falsey
@@ -187,12 +183,39 @@ describe CampactUserService::Account do
     it 'should not allow prefilling where the user has opted out' do
       stub_request(:get, "https://test.com/v1/accounts/#{user_id}")
         .to_return(body: {
-          "preferences": {
-            "prefill_forms": "disallowed"
-          }
+          "prefill_forms_state": "forbidden"
         }.to_json)
 
       expect(subject.allow_prefill?).to be_falsey
     end
   end
+
+  describe "#prefill_undecided?" do
+    it 'should be true if the user has not decided' do
+      stub_request(:get, "https://test.com/v1/accounts/#{user_id}")
+        .to_return(body: {
+          "prefill_forms_state": "undecided"
+        }.to_json)
+
+      expect(subject.prefill_undecided?).to be_truthy
+    end
+
+    it 'should be false if the user has opted-in' do
+      stub_request(:get, "https://test.com/v1/accounts/#{user_id}")
+        .to_return(body: {
+          "prefill_forms_state":  "allowed"
+        }.to_json)
+
+      expect(subject.prefill_undecided?).to be_falsey
+    end
+
+    it 'should be false if the user has opted out' do
+      stub_request(:get, "https://test.com/v1/accounts/#{user_id}")
+        .to_return(body: {
+          "prefill_forms_state":  "forbidden"
+        }.to_json)
+
+      expect(subject.prefill_undecided?).to be_falsey
+    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)
-      external_account_id = '189b6864-d58a-4f49-8370-4ae0b854a40e'
+      account_id = '189b6864-d58a-4f49-8370-4ae0b854a40e'
       account_api = double
-      expect(CampactUserService::Account).to receive(:new).with(client, external_account_id).and_return(account_api)
+      expect(CampactUserService::Account).to receive(:new).with(client, account_id).and_return(account_api)
 
-      account = subject.account(external_account_id, options)
+      account = subject.account(account_id, options)
 
       expect(account).to be(account_api)
     end

data/spec/client_spec.rb

@@ -11,6 +11,10 @@ describe CampactUserService::Client do
     }
     let(:faraday_builder) { double(adapter: true) }
 
+    before :each do
+      allow(faraday_builder).to receive(:request).with(:json)
+    end
+
     it 'should initialize connection from options' do
       expect(faraday_builder).to receive(:adapter).with(:an_adapter)
 
@@ -87,7 +91,7 @@ describe CampactUserService::Client do
     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(Faraday).to receive(:new).and_yield(double(adapter: true, request: 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
@@ -167,11 +171,49 @@ describe CampactUserService::Client do
     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(Faraday).to receive(:new).and_yield(double(adapter: true, request: 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
+
+  describe '#patch_request' do
+    let(:connection) { double }
+    let(:request_builder) { double }
+    let(:request_builder_options) { double }
+    let(:response) { double(body: '') }
+    let(:method_under_test) { :patch_request }
+
+    subject { CampactUserService::Client.new(host: 'demo.campact.de') }
+
+    context 'with faraday stubbed' do
+      before :each do
+        expect(Faraday).to receive(:new).and_yield(double(adapter: true, request: true)).and_return(connection)
+        expect(request_builder).to receive(:options).at_least(:once).and_return(request_builder_options)
+        expect(connection).to receive(:patch).and_yield(request_builder).and_return(response)
+      end
+
+      include_examples 'error handling'
+    end
+
+    context 'with HTTP connection stubbed' do
+      before(:each) do
+        WebMock.disable_net_connect!
+      end
+
+      it 'should send the body included in options' do
+        stub_patch =
+          stub_request(:patch, 'https://demo.campact.de/foo/bar')
+            .with(body: { a_field: 'foo', another_field: 'bar' }.to_json,
+                  headers: { 'Content-Type'=>'application/json' })
+            .to_return(status: 204)
+
+        subject.patch_request('/foo/bar', body: { a_field: 'foo', another_field: 'bar' })
+
+        assert_requested(stub_patch)
+      end
+    end
+  end
 end

data/spec/prefill_forms_spec.rb

@@ -0,0 +1,76 @@
+require 'spec_helper'
+
+describe CampactUserService::PrefillForms do
+  let(:client) { CampactUserService::Client.new(host: 'test.com') }
+  let(:account_id) { 'abcdef123456fedcba' }
+
+  subject do
+    CampactUserService::PrefillForms.new(client, account_id)
+  end
+
+  before(:each) do
+    WebMock.disable_net_connect!
+  end
+
+  describe '#update_prefill_forms' do
+    it 'should update the prefill forms state with just the state and petition slug' do
+      stub_patch_prefill_forms = stub_request(:patch, "https://test.com/v1/prefill_forms?account_id=#{account_id}")
+        .with(body: {
+          prefill_forms: {
+            state: 'allowed',
+            slug: 'save-the-forest'
+          }
+        })
+        .to_return(status: 204)
+
+      result = subject.update_prefill_forms(prefill_forms_state: 'allowed', campaign_slug: 'save-the-forest')
+
+      assert_requested(stub_patch_prefill_forms)
+      expect(result).to be_truthy
+    end
+
+    it 'should update the prefill forms state including UTM parameters' do
+      utm_params = {
+        utm_campaign: 'a campaign',
+        utm_content: 'a content',
+        utm_medium: 'a medium',
+        utm_source: 'a source',
+        utm_term: 'a term',
+        utm_placement: 'a placement',
+        utm_target: 'a target'
+      }
+      stub_patch_prefill_forms = stub_request(:patch, "https://test.com/v1/prefill_forms?account_id=#{account_id}")
+        .with(body: {
+          prefill_forms: {
+            state: 'allowed',
+            slug: 'save-the-forest'
+          }.merge(utm_params)
+        })
+        .to_return(status: 204)
+
+      subject.update_prefill_forms(prefill_forms_state: 'allowed', campaign_slug: 'save-the-forest', **utm_params)
+
+      assert_requested(stub_patch_prefill_forms)
+    end
+
+    it 'should escape special characters in account_id' do
+      unescaped_account_id = 'user@example.com'
+      escaped_account_id = 'user%40example.com'
+
+      prefill_forms = CampactUserService::PrefillForms.new(client, unescaped_account_id)
+
+      stub_patch_prefill_forms = stub_request(:patch, "https://test.com/v1/prefill_forms?account_id=#{escaped_account_id}")
+        .with(body: {
+          prefill_forms: {
+            state: 'allowed',
+            slug: 'save-the-forest'
+          }
+        })
+        .to_return(status: 204)
+
+      prefill_forms.update_prefill_forms(prefill_forms_state: 'allowed', campaign_slug: 'save-the-forest')
+
+      assert_requested(stub_patch_prefill_forms)
+    end
+  end
+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 '#external_account_id' do
+  describe '#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: {external_account_id: '189b6864-d58a-4f49-8370-4ae0b854a40e'}.to_json)
+        .to_return(body: {account_id: '189b6864-d58a-4f49-8370-4ae0b854a40e'}.to_json)
 
-      expect(subject.external_account_id).to eq('189b6864-d58a-4f49-8370-4ae0b854a40e')
+      expect(subject.account_id).to eq('189b6864-d58a-4f49-8370-4ae0b854a40e')
     end
   end
 

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: campact_user_service
 version: !ruby/object:Gem::Version
-  version: 4.1.1
+  version: 4.2.0
 platform: ruby
 authors:
 - ControlShift
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-04 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rotp
@@ -226,18 +225,19 @@ files:
 - lib/campact_user_service.rb
 - lib/campact_user_service/account.rb
 - lib/campact_user_service/client.rb
+- lib/campact_user_service/prefill_forms.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/prefill_forms_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
@@ -252,8 +252,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Ruby wrapper for Campact User Service
 test_files: []