pactas_itero 0.3.0 → 0.7.0

data/lib/pactas_itero/response/raise_error.rb

@@ -1,16 +1,12 @@
-require 'faraday'
-require 'pactas_itero/error'
+require "faraday"
+require "pactas_itero/error"
 
 module PactasItero
   # Faraday response middleware
   module Response
-
     # This class raises an PactasItero-flavored exception based
     # HTTP status codes returned by the API
-    class RaiseError < Faraday::Response::Middleware
-
-      private
-
+    class RaiseError < Faraday::Middleware
       def on_complete(response)
         if error = PactasItero::Error.from_response(response)
           raise error

data/lib/pactas_itero/version.rb

@@ -1,3 +1,3 @@
 module PactasItero
-  VERSION = "0.3.0".freeze
+  VERSION = "0.7.0".freeze
 end

data/lib/pactas_itero.rb

@@ -1,5 +1,5 @@
-require 'pactas_itero/client'
-require 'pactas_itero/default'
+require "pactas_itero/client"
+require "pactas_itero/default"
 
 module PactasItero
   class << self

data/pactas_itero.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "pactas_itero/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "pactas_itero"
+  spec.version       = PactasItero::VERSION
+  spec.authors       = ["Simon Fröhler"]
+  spec.email         = "simon@shipcloud.io"
+  spec.summary       = 'pactas_itero provides a client mapping for accessing
+    the Pactas Itero API.'
+  spec.description   = 'pactas_itero provides a client mapping for accessing
+    the Pactas Itero API, making it easy to post your data to, and read your
+    data from your Pactas account.'
+  spec.homepage      = "https://github.com/webionate/pactas_itero"
+  spec.license       = "MIT"
+
+  spec.files = Dir["lib/**/*.rb"] + Dir["bin/*"]
+  spec.files += Dir["[A-Z]*"] + Dir["spec/**/*"]
+  spec.test_files    = spec.files.grep(%r{^spec/})
+  spec.executables   = spec.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 2.6"
+
+  spec.add_dependency("faraday_middleware", ">= 1.0")
+  spec.add_dependency("rash_alt")
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 3.11.0"
+  spec.add_development_dependency("rubocop", "~> 1.25.1")
+  spec.add_development_dependency("rubocop-performance", "~> 1.13.2")
+  spec.add_development_dependency("simplecov", "~> 0.16.1")
+  spec.add_development_dependency("webmock", "~> 3.3")
+end

data/spec/fixtures/contract_changes.json

@@ -0,0 +1,22 @@
+[
+  {
+    "id": "620a22082b2290ae0d175bfa",
+    "type": "Upgrade",
+    "timestamp": "2022-02-14T08:34:00.0938297Z",
+    "orderId": "620a22082b2290ae0d175bfc",
+    "contractId": "620a22082b2290ae0d175bf8",
+    "changeDate": "2022-03-14T09:34:00.0938301Z",
+    "newPlanVariantId": "620a22082b2290ae0d175bfb",
+    "newPlanId": "620a22082b2290ae0d175bf9"
+  },
+  {
+    "id": "620a22082b2290ae0d175bfd",
+    "type": "Signup",
+    "timestamp": "2022-02-13T09:34:00.0938319Z",
+    "orderId": "620a22082b2290ae0d175bff",
+    "contractId": "620a22082b2290ae0d175bf8",
+    "changeDate": "2022-02-14T09:34:00.0938319Z",
+    "newPlanVariantId": "620a22082b2290ae0d175bfe",
+    "newPlanId": "620a22082b2290ae0d175bf9"
+  }
+]

data/spec/pactas_itero/api/contracts_spec.rb

@@ -1,55 +1,83 @@
-require 'spec_helper'
+require "spec_helper"
 
 describe PactasItero::Api::Customers do
-  describe '.customer_contracts' do
-    it 'requests the correct resource' do
-      client = PactasItero::Client.new(bearer_token: 'bt')
-      request = stub_get('/api/v1/customers/535783241d8dd00fa0db6b2a/contracts').
-      to_return(
-        body: fixture('contracts.json'),
-        headers: { content_type: 'application/json; charset=utf-8'}
-      )
+  describe ".customer_contracts" do
+    it "requests the correct resource" do
+      client = PactasItero::Client.new(bearer_token: "bt")
+      request = stub_get("/api/v1/customers/535783241d8dd00fa0db6b2a/contracts").
+        to_return(
+          body: fixture("contracts.json"),
+          headers: { content_type: "application/json; charset=utf-8" },
+        )
 
-      client.customer_contracts('535783241d8dd00fa0db6b2a')
+      client.customer_contracts("535783241d8dd00fa0db6b2a")
 
       expect(request).to have_been_made
     end
 
-    it 'returns an array of contracts' do
-      client = PactasItero::Client.new(bearer_token: 'bt')
-      request = stub_get('/api/v1/customers/535783241d8dd00fa0db6b2a/contracts').
-      to_return(
-        body: fixture('contracts.json'),
-        headers: { content_type: 'application/json; charset=utf-8'}
-      )
+    it "returns an array of contracts" do
+      client = PactasItero::Client.new(bearer_token: "bt")
+      request = stub_get("/api/v1/customers/535783241d8dd00fa0db6b2a/contracts").
+        to_return(
+          body: fixture("contracts.json"),
+          headers: { content_type: "application/json; charset=utf-8" },
+        )
 
-      contracts = client.customer_contracts('535783241d8dd00fa0db6b2a')
+      contracts = client.customer_contracts("535783241d8dd00fa0db6b2a")
 
       expect(contracts).to be_a Array
     end
   end
 
-  describe '.contracts' do
-    it 'requests the correct resource' do
-      client = PactasItero::Client.new(bearer_token: 'bt')
-      request = stub_get('/api/v1/contracts').
-      to_return(
-        body: fixture('contracts.json'),
-        headers: { content_type: 'application/json; charset=utf-8'}
-      )
+  describe ".contract_changes" do
+    it "requests the correct resource" do
+      client = PactasItero::Client.new(bearer_token: "bt")
+      request = stub_get("/api/v1/contractChanges?contractId=5357bc4f1d8dd00fa0db6c31").
+        to_return(
+          body: fixture("contract_changes.json"),
+          headers: { content_type: "application/json; charset=utf-8" },
+        )
+
+      client.contract_changes("5357bc4f1d8dd00fa0db6c31")
+
+      expect(request).to have_been_made
+    end
+
+    it "returns an array of contract changes" do
+      client = PactasItero::Client.new(bearer_token: "bt")
+      stub_get("/api/v1/contractChanges?contractId=5357bc4f1d8dd00fa0db6c31").
+        to_return(
+          body: fixture("contract_changes.json"),
+          headers: { content_type: "application/json; charset=utf-8" },
+        )
+
+      contract_changes = client.contract_changes("5357bc4f1d8dd00fa0db6c31")
+
+      expect(contract_changes).to be_a Array
+    end
+  end
+
+  describe ".contracts" do
+    it "requests the correct resource" do
+      client = PactasItero::Client.new(bearer_token: "bt")
+      request = stub_get("/api/v1/contracts").
+        to_return(
+          body: fixture("contracts.json"),
+          headers: { content_type: "application/json; charset=utf-8" },
+        )
 
       client.contracts
 
       expect(request).to have_been_made
     end
 
-    it 'returns an array of contracts' do
-      client = PactasItero::Client.new(bearer_token: 'bt')
-      request = stub_get('/api/v1/contracts').
-      to_return(
-        body: fixture('contracts.json'),
-        headers: { content_type: 'application/json; charset=utf-8'}
-      )
+    it "returns an array of contracts" do
+      client = PactasItero::Client.new(bearer_token: "bt")
+      request = stub_get("/api/v1/contracts").
+        to_return(
+          body: fixture("contracts.json"),
+          headers: { content_type: "application/json; charset=utf-8" },
+        )
 
       contracts = client.contracts
 
@@ -62,7 +90,7 @@ describe PactasItero::Api::Customers do
       client = PactasItero::Client.new(bearer_token: "bt")
       request = stub_get("/api/v1/contracts/some_contract_id/cancellationPreview").to_return(
         body: fixture("contract_cancellation_preview_response.json"),
-        headers: { content_type: "application/json; charset=utf-8" }
+        headers: { content_type: "application/json; charset=utf-8" },
       )
 
       client.contract_cancellation_preview("some_contract_id")
@@ -70,47 +98,47 @@ describe PactasItero::Api::Customers do
       expect(request).to have_been_made
     end
 
-    it 'returns the next possible cancellation date' do
-      client = PactasItero::Client.new(bearer_token: 'bt')
+    it "returns the next possible cancellation date" do
+      client = PactasItero::Client.new(bearer_token: "bt")
       request = stub_get("/api/v1/contracts/some_contract_id/cancellationPreview").to_return(
         body: fixture("contract_cancellation_preview_response.json"),
-        headers: { content_type: "application/json; charset=utf-8" }
+        headers: { content_type: "application/json; charset=utf-8" },
       )
 
       contract_cancellation_preview = client.contract_cancellation_preview("some_contract_id")
 
       expect(
-        contract_cancellation_preview.next_possible_cancellation_date
+        contract_cancellation_preview.next_possible_cancellation_date,
       ).to eq "2015-11-15T10:02:21.2750000Z"
     end
   end
 
-  describe '.update_contract' do
-    it 'requests the correct resource' do
-      client = PactasItero::Client.new(bearer_token: 'bt')
-      request = stub_patch('/api/v1/contracts/contract-id').
-      with(body: { EndDate: '2014-05-23T13:12:47.0760000Z' }.to_json).
-      to_return(
-        body: fixture('contract.json'),
-        headers: { content_type: 'application/json; charset=utf-8'}
-      )
+  describe ".update_contract" do
+    it "requests the correct resource" do
+      client = PactasItero::Client.new(bearer_token: "bt")
+      request = stub_patch("/api/v1/contracts/contract-id").
+        with(body: { EndDate: "2014-05-23T13:12:47.0760000Z" }.to_json).
+        to_return(
+          body: fixture("contract.json"),
+          headers: { content_type: "application/json; charset=utf-8" },
+        )
 
-      client.update_contract('contract-id', { end_date: '2014-05-23T13:12:47.0760000Z' })
+      client.update_contract("contract-id", { end_date: "2014-05-23T13:12:47.0760000Z" })
 
       expect(request).to have_been_made
     end
   end
 
-  describe '.contract' do
-    it 'requests the correct resource' do
-      client = PactasItero::Client.new(bearer_token: 'bt')
-      request = stub_get('/api/v1/contracts/5357bc4f1d8dd00fa0db6c31').
-      to_return(
-        body: fixture('contract.json'),
-        headers: { content_type: 'application/json; charset=utf-8'}
-      )
+  describe ".contract" do
+    it "requests the correct resource" do
+      client = PactasItero::Client.new(bearer_token: "bt")
+      request = stub_get("/api/v1/contracts/5357bc4f1d8dd00fa0db6c31").
+        to_return(
+          body: fixture("contract.json"),
+          headers: { content_type: "application/json; charset=utf-8" },
+        )
 
-      client.contract('5357bc4f1d8dd00fa0db6c31')
+      client.contract("5357bc4f1d8dd00fa0db6c31")
 
       expect(request).to have_been_made
     end

data/spec/pactas_itero/api/customers_spec.rb

@@ -1,30 +1,30 @@
-require 'spec_helper'
+require "spec_helper"
 
 describe PactasItero::Api::Customers do
   describe ".create_customer" do
     it "requests the correct resource" do
-      client = PactasItero::Client.new(bearer_token: 'bt')
+      client = PactasItero::Client.new(bearer_token: "bt")
       post_data = {
-          "Address" => {
-            "City" => "Example City",
-            "Country" => "DE",
-            "HouseNumber" => "42",
-            "PostalCode" => "12345",
-            "Street" => "Example Street"
-          },
-          "CompanyName" => "Example Company",
-          "DefaultBearerMedium" => "Email",
-          "EmailAddress" => "jane.doe@example.com",
-          "ExternalCustomerId" => "1234",
-          "FirstName" => "Jane",
-          "Language" => "de-DE",
-          "LastName" => "Doe",
-          "Locale" => "de-DE",
-          "VatId" => "DE123456710"
+        "Address" => {
+          "City" => "Example City",
+          "Country" => "DE",
+          "HouseNumber" => "42",
+          "PostalCode" => "12345",
+          "Street" => "Example Street",
+        },
+        "CompanyName" => "Example Company",
+        "DefaultBearerMedium" => "Email",
+        "EmailAddress" => "jane.doe@example.com",
+        "ExternalCustomerId" => "1234",
+        "FirstName" => "Jane",
+        "Language" => "de-DE",
+        "LastName" => "Doe",
+        "Locale" => "de-DE",
+        "VatId" => "DE123456710",
       }.to_json
-      request = stub_post('/api/v1/customers').with(body: post_data).to_return(
-        body: fixture('customer.json'),
-        headers: { content_type: 'application/json; charset=utf-8'}
+      request = stub_post("/api/v1/customers").with(body: post_data).to_return(
+        body: fixture("customer.json"),
+        headers: { content_type: "application/json; charset=utf-8" },
       )
 
       client.create_customer(
@@ -33,7 +33,7 @@ describe PactasItero::Api::Customers do
           country: "DE",
           house_number: "42",
           postal_code: "12345",
-          street: "Example Street"
+          street: "Example Street",
         },
         company_name: "Example Company",
         default_bearer_medium: "Email",
@@ -43,35 +43,35 @@ describe PactasItero::Api::Customers do
         language: "de-DE",
         last_name: "Doe",
         locale: "de-DE",
-        vat_id: "DE123456710"
+        vat_id: "DE123456710",
       )
 
       expect(request).to have_been_made
     end
 
-    it 'returns the created customer' do
-      client = PactasItero::Client.new(bearer_token: 'bt')
+    it "returns the created customer" do
+      client = PactasItero::Client.new(bearer_token: "bt")
       post_data = {
-          "Address" => {
-            "City" => "Example City",
-            "Country" => "DE",
-            "HouseNumber" => "42",
-            "PostalCode" => "12345",
-            "Street" => "Example Street"
-          },
-          "CompanyName" => "Example Company",
-          "DefaultBearerMedium" => "Email",
-          "EmailAddress" => "jane.doe@example.com",
-          "ExternalCustomerId" => "1234",
-          "FirstName" => "Jane",
-          "Language" => "de-DE",
-          "LastName" => "Doe",
-          "Locale" => "de-DE",
-          "VatId" => "DE123456710"
+        "Address" => {
+          "City" => "Example City",
+          "Country" => "DE",
+          "HouseNumber" => "42",
+          "PostalCode" => "12345",
+          "Street" => "Example Street",
+        },
+        "CompanyName" => "Example Company",
+        "DefaultBearerMedium" => "Email",
+        "EmailAddress" => "jane.doe@example.com",
+        "ExternalCustomerId" => "1234",
+        "FirstName" => "Jane",
+        "Language" => "de-DE",
+        "LastName" => "Doe",
+        "Locale" => "de-DE",
+        "VatId" => "DE123456710",
       }.to_json
-      request = stub_post('/api/v1/customers').with(body: post_data).to_return(
-        body: fixture('customer.json'),
-        headers: { content_type: 'application/json; charset=utf-8'}
+      request = stub_post("/api/v1/customers").with(body: post_data).to_return(
+        body: fixture("customer.json"),
+        headers: { content_type: "application/json; charset=utf-8" },
       )
 
       customer = client.create_customer(
@@ -80,7 +80,7 @@ describe PactasItero::Api::Customers do
           country: "DE",
           house_number: "42",
           postal_code: "12345",
-          street: "Example Street"
+          street: "Example Street",
         },
         company_name: "Example Company",
         default_bearer_medium: "Email",
@@ -90,7 +90,7 @@ describe PactasItero::Api::Customers do
         language: "de-DE",
         last_name: "Doe",
         locale: "de-DE",
-        vat_id: "DE123456710"
+        vat_id: "DE123456710",
       )
 
       address = customer.address
@@ -101,7 +101,7 @@ describe PactasItero::Api::Customers do
       expect(address.street).to eq "Example Street"
 
       expect(customer.company_name).to eq "Example Company"
-      expect(customer.default_bearer_medium).to eq"Email"
+      expect(customer.default_bearer_medium).to eq "Email"
       expect(customer.email_address).to eq "jane.doe@example.com"
       expect(customer.external_customer_id).to eq "1234"
       expect(customer.first_name).to eq "Jane"
@@ -114,49 +114,49 @@ describe PactasItero::Api::Customers do
 
   describe ".customers" do
     it "requests the correct resource" do
-      client = PactasItero::Client.new(bearer_token: 'bt')
-      request = stub_get('/api/v1/customers').
-      to_return(
-        body: fixture('customers.json'),
-        headers: { content_type: 'application/json; charset=utf-8'}
-      )
+      client = PactasItero::Client.new(bearer_token: "bt")
+      request = stub_get("/api/v1/customers").
+        to_return(
+          body: fixture("customers.json"),
+          headers: { content_type: "application/json; charset=utf-8" },
+        )
 
       client.customers
 
       expect(request).to have_been_made
     end
 
-    it 'returns an array of customers' do
-      client = PactasItero::Client.new(bearer_token: 'bt')
-      request = stub_get('/api/v1/customers').
-      to_return(
-        body: fixture('customers.json'),
-        headers: { content_type: 'application/json; charset=utf-8'}
-      )
+    it "returns an array of customers" do
+      client = PactasItero::Client.new(bearer_token: "bt")
+      request = stub_get("/api/v1/customers").
+        to_return(
+          body: fixture("customers.json"),
+          headers: { content_type: "application/json; charset=utf-8" },
+        )
 
       customers = client.customers
 
       expect(customers).to be_a Array
       customer = customers.first
 
-      expect(customer.company_name).to eq 'Example Company'
-      expect(customer.created_at).to eq '2014-05-12T14:22:24.0000000Z'
-      expect(customer.customer_name).to eq 'Example Company'
-      expect(customer.customer_type).to eq 'Consumer'
-      expect(customer.default_bearer_medium).to eq 'Email'
-      expect(customer.email_address).to eq 'jane.doe@example.com'
-      expect(customer.external_customer_id).to eq ''
-      expect(customer.first_name).to eq 'Jane'
-      expect(customer.id).to eq '5370d9201d8dd006288221b0'
-      expect(customer.language).to eq 'de-DE'
-      expect(customer.last_name ).to eq 'Doe'
-      expect(customer.locale).to eq 'de-DE'
-      expect(customer.vat_id).to eq 'DE123456710'
-      expect(customer.address.city).to eq 'Example City'
-      expect(customer.address.country).to eq 'DE'
-      expect(customer.address.house_number).to eq '42'
-      expect(customer.address.postal_code).to eq '12345'
-      expect(customer.address.street).to eq 'Example Street'
+      expect(customer.company_name).to eq "Example Company"
+      expect(customer.created_at).to eq "2014-05-12T14:22:24.0000000Z"
+      expect(customer.customer_name).to eq "Example Company"
+      expect(customer.customer_type).to eq "Consumer"
+      expect(customer.default_bearer_medium).to eq "Email"
+      expect(customer.email_address).to eq "jane.doe@example.com"
+      expect(customer.external_customer_id).to eq ""
+      expect(customer.first_name).to eq "Jane"
+      expect(customer.id).to eq "5370d9201d8dd006288221b0"
+      expect(customer.language).to eq "de-DE"
+      expect(customer.last_name).to eq "Doe"
+      expect(customer.locale).to eq "de-DE"
+      expect(customer.vat_id).to eq "DE123456710"
+      expect(customer.address.city).to eq "Example City"
+      expect(customer.address.country).to eq "DE"
+      expect(customer.address.house_number).to eq "42"
+      expect(customer.address.postal_code).to eq "12345"
+      expect(customer.address.street).to eq "Example Street"
     end
   end
 
@@ -190,7 +190,7 @@ describe PactasItero::Api::Customers do
       expect(address.street).to eq "Example Street"
 
       expect(customer.company_name).to eq "Example Company"
-      expect(customer.default_bearer_medium).to eq"Email"
+      expect(customer.default_bearer_medium).to eq "Email"
       expect(customer.email_address).to eq "jane.doe@example.com"
       expect(customer.external_customer_id).to eq "1234"
       expect(customer.first_name).to eq "Jane"
@@ -201,28 +201,30 @@ describe PactasItero::Api::Customers do
     end
   end
 
-  describe '.update_customer' do
-    it 'requests the correct resource' do
-      client = PactasItero::Client.new(bearer_token: 'bt')
-      request = stub_patch('/api/v1/customers/customer-id').
-      with(
-        body: {
-          CompanyName: 'example & sons',
-          VatId: 'DE555',
-          Address: { Street: 'abc street' }
-        }.to_json
-      ).
-      to_return(
-        body: fixture('customer.json'),
-        headers: { content_type: 'application/json; charset=utf-8'}
+  describe ".update_customer" do
+    it "requests the correct resource" do
+      client = PactasItero::Client.new(bearer_token: "bt")
+      request = stub_patch("/api/v1/customers/customer-id").
+        with(
+          body: {
+            CompanyName: "example & sons",
+            VatId: "DE555",
+            Address: { Street: "abc street" },
+          }.to_json,
+        ).
+        to_return(
+          body: fixture("customer.json"),
+          headers: { content_type: "application/json; charset=utf-8" },
+        )
+
+      client.update_customer(
+        "customer-id", {
+          company_name: "example & sons",
+          vat_id: "DE555",
+          address: { street: "abc street" },
+        }
       )
 
-      client.update_customer('customer-id', {
-        company_name: 'example & sons',
-        vat_id: 'DE555',
-        address: { street: 'abc street' }
-      })
-
       expect(request).to have_been_made
     end
   end