pactas_itero 0.2.0

data/spec/fixtures/contract_cancellation_preview_response.json

@@ -0,0 +1,73 @@
+{
+  "ContractAfter": {
+    "Balance": 0,
+    "Currency": "EUR",
+    "CurrentPhase": {
+      "PlanId": "53567a9e1d8dd00df056564d",
+      "StartDate": "2015-10-15T09:02:21.2750000Z",
+      "Type": "Trial"
+    },
+    "CustomFields": {},
+    "CustomerId": "561f6b9d1d8dd21334f22cb0",
+    "CustomerName": "Example Corp.",
+    "EndDate": "2015-12-15T10:02:21.2750000Z",
+    "EscalationSuspended": false,
+    "Id": "561f6b9d1d8dd21334f22cb2",
+    "LifecycleStatus": "InTrial",
+    "NextBillingDate": "2015-11-15T10:02:21.2750000Z",
+    "PaymentBearer": {
+      "CardType": "visa",
+      "Country": "DE",
+      "ExpiryMonth": 12,
+      "ExpiryYear": 2017,
+      "Holder": "Marcellus Wallace",
+      "Last4": "1111",
+      "Type": "CreditCard"
+    },
+    "PaymentProvider": "Paymill",
+    "PaymentProviderSupportRefunds": true,
+    "Phases": [
+      {
+          "PlanId": "53567a9e1d8dd00df056564d",
+          "StartDate": "2015-10-15T09:02:21.2750000Z",
+          "Type": "Trial"
+      },
+      {
+          "PlanId": "53567a9e1d8dd00df056564d",
+          "PlanVariantId": "53567b431d8dd00df056564f",
+          "StartDate": "2015-11-15T10:02:21.2750000Z",
+          "Type": "Normal"
+      },
+      {
+          "StartDate": "2015-12-15T10:02:21.2750000Z",
+          "Type": "Inactive"
+      }
+    ],
+    "PlanGroupId": "53567a731d8dd00df056564a",
+    "PlanId": "53567a9e1d8dd00df056564d",
+    "RecurringPaymentsPaused": false,
+    "ReferenceCode": "RFDT-ZHXM",
+    "StartDate": "2015-10-15T09:02:21.2750000Z"
+  },
+  "EndDate": "2015-12-15T10:02:21.2750000Z",
+  "Invoice": {
+      "ContractId": "561f6b9d1d8dd21334f22cb2",
+      "CustomerId": "561f6b9d1d8dd21334f22cb0",
+      "ItemList": [],
+      "RecipientAddress": {
+          "City": "Example City",
+          "Country": "DE",
+          "HouseNumber": "42",
+          "PostalCode": "12345",
+          "Street": "Example Street"
+      },
+      "RecipientName": "Example Corp.",
+      "RecipientSubName": "Max Mustermann",
+      "ReverseCharge": false,
+      "TotalGross": 0,
+      "TotalNet": 0,
+      "TotalVat": 0,
+      "VatDescriptors": []
+  },
+  "NextPossibleCancellationDate": "2015-11-15T10:02:21.2750000Z"
+}

data/spec/fixtures/contracts.json

@@ -0,0 +1,48 @@
+[
+  {
+    "Balance": 0,
+    "BilledUntil": "2014-05-23T13:12:47.0760000Z",
+    "Currency": "EUR",
+    "CurrentPhase": {
+        "PlanId": "53567a9e1d8dd00df056564d",
+        "PlanVariantId": "53567b431d8dd00df056564f",
+        "StartDate": "2014-04-23T13:12:47.0760000Z",
+        "Type": "Normal"
+    },
+    "CustomerId": "5357bc4f1d8dd00fa0db6c31",
+    "CustomerName": "Max Mustermann",
+    "EndDate": "2014-05-23T13:12:47.0760000Z",
+    "EscalationSuspended": false,
+    "Id": "5357bc4f1d8dd00fa0db6c32",
+    "LastBillingDate": "2014-04-23T13:12:47.0760000Z",
+    "LifecycleStatus": "Active",
+    "NextBillingDate": "2014-05-23T13:12:47.0760000Z",
+    "PaymentBearer": {
+        "CardType": "visa",
+        "Country": "DE",
+        "ExpiryMonth": 12,
+        "ExpiryYear": 2017,
+        "Holder": "Marcellus Wallace",
+        "Last4": "1111",
+        "Type": "CreditCard"
+    },
+    "PaymentProvider": "Paymill",
+    "Phases": [
+        {
+            "PlanId": "53567a9e1d8dd00df056564d",
+            "PlanVariantId": "53567b431d8dd00df056564f",
+            "StartDate": "2014-04-23T13:12:47.0760000Z",
+            "Type": "Normal"
+        },
+        {
+            "StartDate": "2014-05-23T13:12:47.0760000Z",
+            "Type": "Inactive"
+        }
+    ],
+    "PlanGroupId": "53567a731d8dd00df056564a",
+    "PlanId": "53567a9e1d8dd00df056564d",
+    "PlanVariantId": "53567b431d8dd00df056564f",
+    "RecurringPaymentsPaused": false,
+    "StartDate": "2014-04-23T13:12:47.0760000Z"
+  }
+]

data/spec/fixtures/create_order_response.json

@@ -0,0 +1,17 @@
+{
+  "Id": "537dfcab9e400760b4cd6347",
+  "AllowWithoutPaymentData": false,
+  "ComponentSubscriptions": [{
+    "PreventModification": false,
+    "VatPercentage": 0,
+    "TotalNet": 0,
+    "TotalVat": 0,
+    "ComponentId": "534bbdcc9e400722602f5a21",
+    "Quantity": 1
+  }],
+  "Total": -0.99,
+  "TotalVat": -0.19,
+  "IsTrial": false,
+  "CustomerId": "5370e5ab9e40071fd01e01df",
+  "ContractId": "5370e5ab9e40071fd01e01e0"
+}

data/spec/fixtures/create_rated_item.json

@@ -0,0 +1,8 @@
+{
+    "Description": "the description",
+    "PeriodEnd": "2014-09-19T08:18:51.907Z",
+    "PeriodStart": "2014-09-19T08:18:51.907Z",
+    "PricePerUnit": 123.45,
+    "Quantity": 2,
+    "TaxPolicyId": "tax-policy-id"
+}

data/spec/fixtures/customer.json

@@ -0,0 +1,23 @@
+{
+    "Address": {
+      "City": "Example City",
+      "Country": "DE",
+      "HouseNumber": "42",
+      "PostalCode": "12345",
+      "Street": "Example Street"
+    },
+    "CompanyName": "Example Company",
+    "CreatedAt": "2014-05-12T14:22:24.0000000Z",
+    "CustomerName": "Example Company",
+    "CustomerType": "Consumer",
+    "DefaultBearerMedium": "Email",
+    "EmailAddress": "jane.doe@example.com",
+    "ExternalCustomerId": "",
+    "FirstName": "Jane",
+    "Id": "5370d9201d8dd006288221b0",
+    "Language": "de-DE",
+    "LastName": "Doe",
+    "Locale": "de-DE",
+    "VatId": "DE123456710",
+    "ExternalCustomerId": "1234"
+}

data/spec/fixtures/customers.json

@@ -0,0 +1,40 @@
+[
+    {
+        "Address": {
+          "City": "Example City",
+          "Country": "DE",
+          "HouseNumber": "42",
+          "PostalCode": "12345",
+          "Street": "Example Street"
+        },
+        "CompanyName": "Example Company",
+        "CreatedAt": "2014-05-12T14:22:24.0000000Z",
+        "CustomerName": "Example Company",
+        "CustomerType": "Consumer",
+        "DefaultBearerMedium": "Email",
+        "EmailAddress": "jane.doe@example.com",
+        "ExternalCustomerId": "",
+        "FirstName": "Jane",
+        "Id": "5370d9201d8dd006288221b0",
+        "Language": "de-DE",
+        "LastName": "Doe",
+        "Locale": "de-DE",
+        "VatId": "DE123456710"
+    },
+    {
+        "Address": {},
+        "CompanyName": "Test Inc.",
+        "CreatedAt": "2014-05-14T14:21:20.0000000Z",
+        "CustomerName": "Test Inc.",
+        "CustomerType": "Consumer",
+        "DefaultBearerMedium": "Email",
+        "EmailAddress": "john.test@example.com",
+        "ExternalCustomerId": "",
+        "FirstName": "John",
+        "Id": "5370d8e01d8dd00628822197",
+        "Language": "de-DE",
+        "LastName": "Test",
+        "Locale": "de-DE",
+        "VatId": "DE123456789"
+    }
+]

data/spec/fixtures/invoice.json

@@ -0,0 +1,22 @@
+{
+  "Id": "54b67d9e995ec90bc8f37718",
+  "InvoiceNumber": "SAN//2012//07--2435",
+  "CustomerId": "54b67d9e675ec90bc8f3770c",
+  "SentAt": "2012-07-03T23:02:22Z",
+  "DueDate": "2012-08-02",
+  "RecipientName": "OldTek GmbH",
+  "RecipientSubName": "Hermann Anton Müller",
+  "RecipientAddress": {
+    "AddressLine1": "c/o Andreas Meister",
+    "Street": "Sternstraße",
+    "HouseNumber": "43",
+    "PostalCode": "80538",
+    "City": "München",
+    "Country": "DE"
+  },
+  "Currency": "EUR",
+  "TotalNet": "211.60",
+  "TotalVat": "40.20",
+  "TotalGross": "251.80",
+  "IsInvoice": "False"
+}

data/spec/fixtures/invoices.json

@@ -0,0 +1,46 @@
+[
+  {
+    "Id": "54b67d9e675ec90bc8f37718",
+    "InvoiceNumber": "SAN//2012//07--2434",
+    "CustomerId": "54b67d9e675ec90bc8f3770c",
+    "SentAt": "2012-07-03T23:02:22Z",
+    "DueDate": "2012-08-02",
+    "RecipientName": "OldTek GmbH",
+    "RecipientSubName": "Hermann Anton Müller",
+    "RecipientAddress": {
+      "AddressLine1": "c/o Andreas Meister",
+      "Street": "Sternstraße",
+      "HouseNumber": "43",
+      "PostalCode": "80538",
+      "City": "München",
+      "Country": "DE"
+    },
+    "Currency": "EUR",
+    "TotalNet": "211.60",
+    "TotalVat": "40.20",
+    "TotalGross": "251.80",
+    "IsInvoice": "False"
+  },
+  {
+    "Id": "54b67d9e995ec90bc8f37718",
+    "InvoiceNumber": "SAN//2012//07--2435",
+    "CustomerId": "54b67d9e675ec90bc8f3770c",
+    "SentAt": "2012-07-03T23:02:22Z",
+    "DueDate": "2012-08-02",
+    "RecipientName": "OldTek GmbH",
+    "RecipientSubName": "Hermann Anton Müller",
+    "RecipientAddress": {
+      "AddressLine1": "c/o Andreas Meister",
+      "Street": "Sternstraße",
+      "HouseNumber": "43",
+      "PostalCode": "80538",
+      "City": "München",
+      "Country": "DE"
+    },
+    "Currency": "EUR",
+    "TotalNet": "211.60",
+    "TotalVat": "40.20",
+    "TotalGross": "251.80",
+    "IsInvoice": "False"
+  }
+]

data/spec/fixtures/order.json

@@ -0,0 +1,15 @@
+{
+  "Id": "56af22c51d8dd207684db9b5",
+  "PlanVariantId": "5357b8f11d8dd00fa0db6c1b",
+  "AllowWithoutPaymentData": false,
+  "ComponentSubscriptions": [],
+  "DiscountSubscriptions": [],
+  "Currency": "EUR",
+  "Total": 24.9,
+  "TotalVat": 4.73,
+  "TotalGross": 29.63,
+  "IsTrial": false,
+  "Status": "InProgress",
+  "CustomerId": "56af224c1d8dd207684db935",
+  "ContractId": "56af22c51d8dd207684db9b4"
+}

data/spec/pactas_itero/api/contracts_spec.rb

@@ -0,0 +1,118 @@
+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'}
+      )
+
+      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'}
+      )
+
+      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'}
+      )
+
+      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'}
+      )
+
+      contracts = client.contracts
+
+      expect(contracts).to be_a Array
+    end
+  end
+
+  describe ".contract_cancellation_preview" do
+    it "requests the correct resource" 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" }
+      )
+
+      client.contract_cancellation_preview("some_contract_id")
+
+      expect(request).to have_been_made
+    end
+
+    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" }
+      )
+
+      contract_cancellation_preview = client.contract_cancellation_preview("some_contract_id")
+
+      expect(
+        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'}
+      )
+
+      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'}
+      )
+
+      client.contract('5357bc4f1d8dd00fa0db6c31')
+
+      expect(request).to have_been_made
+    end
+  end
+end

data/spec/pactas_itero/api/customers_spec.rb

@@ -0,0 +1,188 @@
+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')
+      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"
+      }.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'}
+      )
+
+      client.create_customer(
+        address: {
+          city: "Example City",
+          country: "DE",
+          house_number: "42",
+          postal_code: "12345",
+          street: "Example Street"
+        },
+        company_name: "Example Company",
+        default_bearer_medium: "Email",
+        email_address: "jane.doe@example.com",
+        external_customer_id: "1234",
+        first_name: "Jane",
+        language: "de-DE",
+        last_name: "Doe",
+        locale: "de-DE",
+        vat_id: "DE123456710"
+      )
+
+      expect(request).to have_been_made
+    end
+
+    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"
+      }.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'}
+      )
+
+      customer = client.create_customer(
+        address: {
+          city: "Example City",
+          country: "DE",
+          house_number: "42",
+          postal_code: "12345",
+          street: "Example Street"
+        },
+        company_name: "Example Company",
+        default_bearer_medium: "Email",
+        email_address: "jane.doe@example.com",
+        external_customer_id: "1234",
+        first_name: "Jane",
+        language: "de-DE",
+        last_name: "Doe",
+        locale: "de-DE",
+        vat_id: "DE123456710"
+      )
+
+      address = customer.address
+      expect(address.city).to eq "Example City"
+      expect(address.country).to eq "DE"
+      expect(address.house_number).to eq "42"
+      expect(address.postal_code).to eq "12345"
+      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.email_address).to eq "jane.doe@example.com"
+      expect(customer.external_customer_id).to eq "1234"
+      expect(customer.first_name).to eq "Jane"
+      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"
+    end
+  end
+
+  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.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'}
+      )
+
+      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'
+    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'}
+      )
+
+      client.update_customer('customer-id', {
+        company_name: 'example & sons',
+        vat_id: 'DE555',
+        address: { street: 'abc street' }
+      })
+
+      expect(request).to have_been_made
+    end
+  end
+end