invoiced 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae182e66a354b88c600800a9f0ef40ff695c44671c8b3bf2bd24100c61be2cdf
-  data.tar.gz: 3e0897128ea15e9086098560b4beac41e61a97e44a8ec8db542be023e7486e75
+  metadata.gz: 744fba470fc2c3433167b3af46f8f98da1f33fd23c08b4f971c83681f3605cdb
+  data.tar.gz: c4b6db10643c63fbc3bda83199500afaf99e439a0ae93d74d4f7ddf5cff94906
 SHA512:
-  metadata.gz: 4039ccc2d285ddfcdd0c0aa97aae3c02330fdfdbcfddd1e4c559d0f08b101ec698f396baba1f33a075ac11e805318bad24dac55cbabaafd675e7654e33549424
-  data.tar.gz: e2d7415d9b996f6ef9b1a63e80f4b14ebbdf411a1fccff21f07803a53048f4922d3eb015162b7f606b7d7a37e471ad8ef40943a4628e7d8c459b819d65c1ec07
+  metadata.gz: bcc44f6f0071db5b7b6a28ccf557b8f2ba7c38e2e626a8bb542e447919a634fe346acbb3d273313ecaa4d21db0076d059292023494c67fe6d57af59d5465f1a6
+  data.tar.gz: 2617903b3c510f30a170dece7e004fbb04f12c042cc41310e1af04aa790c3654771b0613308c85281ca077d5597eadda5a6404e1c7b25160aef23b38b0df22e2

data/.github/workflows/ci.yml

@@ -0,0 +1,37 @@
+name: CI
+
+on:
+  push:
+    branches: ["master"]
+  pull_request:
+    branches: ["master"]
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version:
+          - '2.3'
+          - '2.4'
+          - '2.5'
+          - '2.6'
+          - '2.7'
+          - '3.0'
+          - '3.1'
+          - '3.2'
+          - '3.3'
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+
+      - name: Tests
+        env:
+          COVERALLS_REPO_TOKEN: ${{ secrets.COVERALLS_REPO_TOKEN }}
+        run: |
+          bundle exec rake

data/.github/workflows/publish.yml

@@ -0,0 +1,24 @@
+name: Publish
+
+on:
+  workflow_dispatch: {}
+
+jobs:
+  publish:
+    name: Publish
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version:  3.3
+
+      - name: Build
+        run: gem build invoiced.gemspec
+
+      - name: Publish gems to Rubygems
+        run: gem push invoiced-*.gem
+        env:
+          GEM_HOST_API_KEY: ${{secrets.GEM_HOST_API_KEY}}

data/Gemfile

@@ -1,7 +1,7 @@
 source "https://rubygems.org"
 gemspec
 
-gem 'rest-client', '~> 2.0.0'
+gem 'rest-client', '~> 2.1.0'
 gem 'jwt', '~> 2.0'
 
 gem 'mocha', '~> 0.13.2', :require => false, :group => :test
@@ -9,7 +9,7 @@ gem 'shoulda', '~> 3.4.0', :require => false, :group => :test
 gem 'test-unit', :require => false, :group => :test
 gem 'rake', :require => false, :group => :test
 gem 'coveralls', :require => false, :group => :test
-gem 'simplecov', '~> 0.10.0', :require => false, :group => :test
-gem 'simplecov-console', '~> 0.3.1', :require => false, :group => :test
+gem 'simplecov', '~> 0.10', :require => false, :group => :test
+gem 'simplecov-console', '~> 0.3', :require => false, :group => :test
 gem 'term-ansicolor', '~> 1.3.2', :require => false, :group => :test
-gem 'tins', '~> 1.6.0', :require => false, :group => :test
+gem 'tins', '~> 1.6.0', :require => false, :group => :test

data/README.md

@@ -3,7 +3,7 @@ invoiced-ruby
 
 This repository contains the Ruby client library for the [Invoiced](https://invoiced.com) API.
 
-[![Build Status](https://travis-ci.com/Invoiced/invoiced-ruby.svg?branch=master)](https://travis-ci.com/Invoiced/invoiced-ruby)
+[![CI](https://github.com/Invoiced/invoiced-ruby/actions/workflows/ci.yml/badge.svg)](https://github.com/Invoiced/invoiced-ruby/actions/workflows/ci.yml)
 [![Coverage Status](https://coveralls.io/repos/Invoiced/invoiced-ruby/badge.svg?branch=master&service=github)](https://coveralls.io/github/Invoiced/invoiced-ruby?branch=master)
 [![Gem Version](https://badge.fury.io/rb/invoiced.svg)](https://badge.fury.io/rb/invoiced)
 
@@ -25,7 +25,7 @@ gem 'invoiced'
 
 ## Requirements
 
-- Ruby 2.1+
+- Ruby 2.3+
 - `rest_client` gem
 - `jwt` gem
 
@@ -73,4 +73,4 @@ The gem can be built with:
 gem build invoiced.gemspec
 ```
 
-The test suite can be ran with `rake test`
+The test suite can be ran with `rake test`

data/invoiced.gemspec

@@ -12,9 +12,9 @@ Gem::Specification.new do |s|
   s.email       = 'support@invoiced.com'
   s.files       = ["lib/invoiced.rb"]
   s.homepage    = 'https://invoiced.com/docs/dev'
-  s.required_ruby_version = '>= 2.1.0'
+  s.required_ruby_version = '>= 2.3.0'
 
-  s.add_dependency('rest-client', '~> 2.0.0')
+  s.add_dependency('rest-client', '~> 2.1.0')
   s.add_dependency('jwt', '~> 2.0')
 
   s.files = `git ls-files`.split("\n")

data/lib/invoiced/bank_account.rb

@@ -1,6 +1,5 @@
 module Invoiced
   class BankAccount < PaymentSourceObject
-
     OBJECT_NAME = 'bank_account'
   end
 end

data/lib/invoiced/card.rb

@@ -1,6 +1,5 @@
 module Invoiced
   class Card < PaymentSourceObject
-
     OBJECT_NAME = 'card'
   end
 end

data/lib/invoiced/custom_field.rb

@@ -0,0 +1,10 @@
+module Invoiced
+  class CustomField < Object
+    include Invoiced::Operations::List
+    include Invoiced::Operations::Create
+    include Invoiced::Operations::Update
+    include Invoiced::Operations::Delete
+
+    OBJECT_NAME = 'custom_field'
+  end
+end

data/lib/invoiced/customer_chasing_cadence.rb

@@ -0,0 +1,10 @@
+module Invoiced
+  class CustomerChasingCadence < Object
+    include Invoiced::Operations::List
+    include Invoiced::Operations::Create
+    include Invoiced::Operations::Update
+    include Invoiced::Operations::Delete
+
+    OBJECT_NAME = 'customer_chasing_cadence'
+  end
+end

data/lib/invoiced/email_template.rb

@@ -0,0 +1,10 @@
+module Invoiced
+  class EmailTemplate < Object
+    include Invoiced::Operations::List
+    include Invoiced::Operations::Create
+    include Invoiced::Operations::Update
+    include Invoiced::Operations::Delete
+
+    OBJECT_NAME = 'email_template'
+  end
+end

data/lib/invoiced/gl_account.rb

@@ -0,0 +1,10 @@
+module Invoiced
+  class GlAccount < Object
+    include Invoiced::Operations::List
+    include Invoiced::Operations::Create
+    include Invoiced::Operations::Update
+    include Invoiced::Operations::Delete
+
+    OBJECT_NAME = 'gl_account'
+  end
+end

data/lib/invoiced/inbox.rb

@@ -0,0 +1,7 @@
+module Invoiced
+  class Inbox < Object
+    include Invoiced::Operations::List
+
+    OBJECT_NAME = 'inbox'
+  end
+end

data/lib/invoiced/invoice_chasing_cadence.rb

@@ -0,0 +1,10 @@
+module Invoiced
+  class InvoiceChasingCadence < Object
+    include Invoiced::Operations::List
+    include Invoiced::Operations::Create
+    include Invoiced::Operations::Update
+    include Invoiced::Operations::Delete
+
+    OBJECT_NAME = 'invoice_chasing_cadence'
+  end
+end

data/lib/invoiced/late_fee_schedule.rb

@@ -0,0 +1,10 @@
+module Invoiced
+  class LateFeeSchedule < Object
+    include Invoiced::Operations::List
+    include Invoiced::Operations::Create
+    include Invoiced::Operations::Update
+    include Invoiced::Operations::Delete
+
+    OBJECT_NAME = 'late_fee_schedule'
+  end
+end

data/lib/invoiced/member.rb

@@ -0,0 +1,10 @@
+module Invoiced
+  class Member < Object
+    include Invoiced::Operations::List
+    include Invoiced::Operations::Create
+    include Invoiced::Operations::Update
+    include Invoiced::Operations::Delete
+
+    OBJECT_NAME = 'member'
+  end
+end

data/lib/invoiced/merchant_account.rb

@@ -0,0 +1,10 @@
+module Invoiced
+  class MerchantAccount < Object
+    include Invoiced::Operations::List
+    include Invoiced::Operations::Create
+    include Invoiced::Operations::Update
+    include Invoiced::Operations::Delete
+
+    OBJECT_NAME = 'merchant_account'
+  end
+end

data/lib/invoiced/object.rb

@@ -35,7 +35,11 @@ module Invoiced
 
         def build_endpoint
             if self.class.const_defined? "OBJECT_NAME"
-                '/' + self.class::OBJECT_NAME + 's'
+                if self.class::OBJECT_NAME == 'inbox'
+                    '/inboxes'
+                else
+                    '/' + self.class::OBJECT_NAME + 's'
+                end
             else
                 '/objects'
             end

data/lib/invoiced/payment_method.rb

@@ -0,0 +1,8 @@
+module Invoiced
+  class PaymentMethod < Object
+    include Invoiced::Operations::List
+    include Invoiced::Operations::Update
+
+    OBJECT_NAME = 'payment_method'
+  end
+end

data/lib/invoiced/pdf_template.rb

@@ -0,0 +1,10 @@
+module Invoiced
+  class PdfTemplate < Object
+    include Invoiced::Operations::List
+    include Invoiced::Operations::Create
+    include Invoiced::Operations::Update
+    include Invoiced::Operations::Delete
+
+    OBJECT_NAME = 'pdf_template'
+  end
+end

data/lib/invoiced/report.rb

@@ -0,0 +1,7 @@
+module Invoiced
+  class Report < Object
+    include Invoiced::Operations::Create
+
+    OBJECT_NAME = 'report'
+  end
+end

data/lib/invoiced/role.rb

@@ -0,0 +1,10 @@
+module Invoiced
+  class Role < Object
+    include Invoiced::Operations::List
+    include Invoiced::Operations::Create
+    include Invoiced::Operations::Update
+    include Invoiced::Operations::Delete
+
+    OBJECT_NAME = 'role'
+  end
+end

data/lib/invoiced/sign_up_page.rb

@@ -0,0 +1,10 @@
+module Invoiced
+  class SignUpPage < Object
+    include Invoiced::Operations::List
+    include Invoiced::Operations::Create
+    include Invoiced::Operations::Update
+    include Invoiced::Operations::Delete
+
+    OBJECT_NAME = 'sign_up_page'
+  end
+end

data/lib/invoiced/sms_template.rb

@@ -0,0 +1,10 @@
+module Invoiced
+  class SmsTemplate < Object
+    include Invoiced::Operations::List
+    include Invoiced::Operations::Create
+    include Invoiced::Operations::Update
+    include Invoiced::Operations::Delete
+
+    OBJECT_NAME = 'sms_template'
+  end
+end

data/lib/invoiced/tax_rule.rb

@@ -0,0 +1,10 @@
+module Invoiced
+  class TaxRule < Object
+    include Invoiced::Operations::List
+    include Invoiced::Operations::Create
+    include Invoiced::Operations::Update
+    include Invoiced::Operations::Delete
+
+    OBJECT_NAME = 'tax_rule'
+  end
+end

data/lib/invoiced/theme.rb

@@ -0,0 +1,10 @@
+module Invoiced
+  class Theme < Object
+    include Invoiced::Operations::List
+    include Invoiced::Operations::Create
+    include Invoiced::Operations::Update
+    include Invoiced::Operations::Delete
+
+    OBJECT_NAME = 'theme'
+  end
+end

data/lib/invoiced/version.rb

@@ -1,3 +1,3 @@
 module Invoiced
-  VERSION = '2.0.0'
-end
+  VERSION = '3.0.0'
+end

data/lib/invoiced/webhook.rb

@@ -0,0 +1,10 @@
+module Invoiced
+  class Webhook < Object
+    include Invoiced::Operations::List
+    include Invoiced::Operations::Create
+    include Invoiced::Operations::Update
+    include Invoiced::Operations::Delete
+
+    OBJECT_NAME = 'webhook'
+  end
+end

data/lib/invoiced.rb

@@ -19,6 +19,7 @@ require 'invoiced/operations/update'
 
 require 'invoiced/object'
 require 'invoiced/payment_source_object'
+
 require 'invoiced/attachment'
 require 'invoiced/bank_account'
 require 'invoiced/card'
@@ -27,25 +28,43 @@ require 'invoiced/contact'
 require 'invoiced/coupon'
 require 'invoiced/credit_balance_adjustment'
 require 'invoiced/credit_note'
+require 'invoiced/custom_field'
 require 'invoiced/customer'
+require 'invoiced/customer_chasing_cadence'
 require 'invoiced/email'
+require 'invoiced/email_template'
 require 'invoiced/estimate'
 require 'invoiced/event'
 require 'invoiced/file'
+require 'invoiced/gl_account'
+require 'invoiced/inbox'
 require 'invoiced/invoice'
+require 'invoiced/invoice_chasing_cadence'
 require 'invoiced/item'
+require 'invoiced/late_fee_schedule'
 require 'invoiced/letter'
 require 'invoiced/line_item'
+require 'invoiced/member'
+require 'invoiced/merchant_account'
 require 'invoiced/note'
 require 'invoiced/payment'
+require 'invoiced/payment_method'
 require 'invoiced/payment_plan'
 require 'invoiced/payment_source'
+require 'invoiced/pdf_template'
 require 'invoiced/plan'
 require 'invoiced/refund'
+require 'invoiced/report'
+require 'invoiced/role'
+require 'invoiced/sign_up_page'
+require 'invoiced/sms_template'
 require 'invoiced/subscription'
 require 'invoiced/task'
 require 'invoiced/tax_rate'
+require 'invoiced/tax_rule'
 require 'invoiced/text_message'
+require 'invoiced/theme'
+require 'invoiced/webhook'
 
 module Invoiced
     class Client
@@ -56,7 +75,7 @@ module Invoiced
         ReadTimeout = 80
 
         attr_reader :api_key, :api_url, :sandbox, :sso_key
-        attr_reader :Item, :Charge, :Coupon, :CreditBalanceAdjustment, :CreditNote, :Customer, :Estimate, :Event, :File, :Invoice, :Note, :Payment, :Plan, :Refund, :Subscription, :Task, :TaxRate
+        attr_reader :Charge, :Coupon, :CreditBalanceAdjustment, :CreditNote, :CustomField, :Customer, :CustomerChasingCadence, :EmailTemplate, :Estimate, :Event, :File, :GlAccount, :Inbox, :Invoice, :InvoiceChasingCadence, :Item, :LateFeeSchedule, :Member, :MerchantAccount, :Note, :Payment, :PaymentMethod, :PdfTemplate, :Plan, :Refund, :Report, :Role, :SignUpPage, :SmsTemplate, :Subscription, :Task, :TaxRate, :TaxRule, :Theme, :Webhook
 
         def initialize(api_key, sandbox=false, sso_key=false)
           @api_key = api_key
@@ -65,23 +84,41 @@ module Invoiced
           @sso_key = sso_key
 
           # Object endpoints
-          @Item = Invoiced::Item.new(self)
           @Charge = Invoiced::Charge.new(self)
           @Coupon = Invoiced::Coupon.new(self)
           @CreditBalanceAdjustment = Invoiced::CreditBalanceAdjustment.new(self)
           @CreditNote = Invoiced::CreditNote.new(self)
+          @CustomField = Invoiced::CustomField.new(self)
           @Customer = Invoiced::Customer.new(self)
+          @CustomerChasingCadence = Invoiced::CustomerChasingCadence.new(self)
+          @EmailTemplate = Invoiced::EmailTemplate.new(self)
           @Estimate = Invoiced::Estimate.new(self)
           @Event = Invoiced::Event.new(self)
           @File = Invoiced::File.new(self)
+          @GlAccount = Invoiced::GlAccount.new(self)
+          @Inbox = Invoiced::Inbox.new(self)
           @Invoice = Invoiced::Invoice.new(self)
+          @InvoiceChasingCadence = Invoiced::InvoiceChasingCadence.new(self)
+          @Item = Invoiced::Item.new(self)
+          @LateFeeSchedule = Invoiced::LateFeeSchedule.new(self)
+          @Member = Invoiced::Member.new(self)
+          @MerchantAccount = Invoiced::MerchantAccount.new(self)
           @Note = Invoiced::Note.new(self)
           @Payment = Invoiced::Payment.new(self)
+          @PaymentMethod = Invoiced::PaymentMethod.new(self)
+          @PdfTemplate = Invoiced::PdfTemplate.new(self)
           @Plan = Invoiced::Plan.new(self)
           @Refund = Invoiced::Refund.new(self)
+          @Report = Invoiced::Report.new(self)
+          @Role = Invoiced::Role.new(self)
+          @SignUpPage = Invoiced::SignUpPage.new(self)
+          @SmsTemplate = Invoiced::SmsTemplate.new(self)
           @Subscription = Invoiced::Subscription.new(self)
           @Task = Invoiced::Task.new(self)
           @TaxRate = Invoiced::TaxRate.new(self)
+          @TaxRule = Invoiced::TaxRule.new(self)
+          @Theme = Invoiced::Theme.new(self)
+          @Webhook = Invoiced::Webhook.new(self)
         end
 
         def request(method, endpoint, params={}, opts={})

data/test/invoiced/charge_test.rb

@@ -2,9 +2,11 @@ require File.expand_path('../../test_helper', __FILE__)
 
 module Invoiced
   class ChargeTest < Test::Unit::TestCase
-    should "return the api endpoint" do
-      charge = Charge.new(@client, 123)
-      assert_equal('/charges/123', charge.endpoint())
+    include Invoiced::Operations::EndpointTest
+
+    setup do
+      @objectClass = Charge
+      @endpoint = '/charges'
     end
 
     should "create a charge" do
@@ -16,10 +18,10 @@ module Invoiced
       RestClient::Request.any_instance.expects(:execute).returns(mockResponse)
 
       charge = Charge.new(@client, 1234)
-      charge = charge.create(:amount => 100, :payment_source_type => "card")
+      payment = charge.create(:amount => 100, :payment_source_type => "card")
 
-      assert_instance_of(Invoiced::Payment, charge)
-      assert_equal(charge.id, "a1b2c3")
+      assert_instance_of(Invoiced::Payment, payment)
+      assert_equal(payment.id, "a1b2c3")
     end
   end
 end

data/test/invoiced/contact_test.rb

@@ -2,92 +2,16 @@ require File.expand_path('../../test_helper', __FILE__)
 
 module Invoiced
   class ContactTest < Test::Unit::TestCase
-    should "return the api endpoint" do
-      contact = Contact.new(@client, 123)
-      assert_equal('/contacts/123', contact.endpoint())
-    end
-
-    should "create a contact" do
-      mockResponse = mock('RestClient::Response')
-      mockResponse.stubs(:code).returns(201)
-      mockResponse.stubs(:body).returns('{"id":123,"name":"Nancy"}')
-      mockResponse.stubs(:headers).returns({})
-
-      RestClient::Request.any_instance.expects(:execute).returns(mockResponse)
-
-      contact = Contact.new(@client)
-      contact = contact.create({:name => "Nancy"})
-
-      assert_instance_of(Invoiced::Contact, contact)
-      assert_equal(123, contact.id)
-      assert_equal("Nancy", contact.name)
-    end
-
-    should "retrieve a contact" do
-      mockResponse = mock('RestClient::Response')
-      mockResponse.stubs(:code).returns(200)
-      mockResponse.stubs(:body).returns('{"id":123,"name":"Nancy"}')
-      mockResponse.stubs(:headers).returns({})
-
-      RestClient::Request.any_instance.expects(:execute).returns(mockResponse)
-
-      contact = Contact.new(@client)
-      contact = contact.retrieve(123)
-
-      assert_instance_of(Invoiced::Contact, contact)
-      assert_equal(123, contact.id)
-      assert_equal("Nancy", contact.name)
-    end
-
-    should "not update a contact when no params" do
-      contact = Contact.new(@client, 123)
-      assert_false(contact.save)
-    end
-
-    should "update a contact" do
-      mockResponse = mock('RestClient::Response')
-      mockResponse.stubs(:code).returns(200)
-      mockResponse.stubs(:body).returns('{"id":123,"name":"Nancy Drew"}')
-      mockResponse.stubs(:headers).returns({})
-
-      RestClient::Request.any_instance.expects(:execute).returns(mockResponse)
-
-      contact = Contact.new(@client, 123)
-      contact.name = "Nancy Drew"
-      assert_true(contact.save)
-
-      assert_equal("Nancy Drew", contact.name)
-    end
-
-    should "list all contacts" do
-      mockResponse = mock('RestClient::Response')
-      mockResponse.stubs(:code).returns(200)
-      mockResponse.stubs(:body).returns('[{"id":123,"name":"Nancy"}]')
-      mockResponse.stubs(:headers).returns(:x_total_count => 15, :link => '<https://api.invoiced.com/contacts?per_page=25&page=1>; rel="self", <https://api.invoiced.com/contacts?per_page=25&page=1>; rel="first", <https://api.invoiced.com/contacts?per_page=25&page=1>; rel="last"')
-
-      RestClient::Request.any_instance.expects(:execute).returns(mockResponse)
-
-      contact = Contact.new(@client)
-      contacts, metadata = contact.list
-
-      assert_instance_of(Array, contacts)
-      assert_equal(1, contacts.length)
-      assert_equal(123, contacts[0].id)
-
-      assert_instance_of(Invoiced::List, metadata)
-      assert_equal(15, metadata.total_count)
-    end
-
-    should "delete a contact" do
-      mockResponse = mock('RestClient::Response')
-      mockResponse.stubs(:code).returns(204)
-      mockResponse.stubs(:body).returns('')
-      mockResponse.stubs(:headers).returns({})
-
-      RestClient::Request.any_instance.expects(:execute).returns(mockResponse)
-
-      contact = Contact.new(@client, 123)
-      assert_true(contact.delete)
+    include Invoiced::Operations::EndpointTest
+    include Invoiced::Operations::CreateTest
+    include Invoiced::Operations::RetrieveTest
+    include Invoiced::Operations::UpdateTest
+    include Invoiced::Operations::DeleteTest
+    include Invoiced::Operations::ListTest
+
+    setup do
+      @objectClass = Contact
+      @endpoint = '/contacts'
     end
   end
 end