invoiced 1.1.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc29d5e9ff33831248d574c23a30169f149ba7b9ed11d2904de174cabba75163
-  data.tar.gz: 4f2b87a74c4a58dffcadd4b46855089ac928a655f4b11e5e07598ea940d5e4b7
+  metadata.gz: 2a4b7176ca132f8c23b695c9f5ab7461400495c89370a953daef96b0e3d72ab6
+  data.tar.gz: 542389f7ff24edf9037fd6b380491b0a9431d8447e0f66a072f4dd2e64e0494a
 SHA512:
-  metadata.gz: c3ba71d623fd4714ecd4975d29a7aa9730ceb8be5daaf8e7324eace2af003e6a986bab11bc83312cbb2316799ebdbfc922fa48b456ab6bb919c61608c33f04af
-  data.tar.gz: eb098797e875032bd88e01452bdb2794cbdec350973ed46fb9ce06c3118b0355b2465643b8ec4aaae3212be46715e7f470826a27b0a2d0bf0c855412873afe8b
+  metadata.gz: 05a9da20d885430266a929bd26320ff50691e14be9ba3e09bea0209645cd9196fa96a7f7867f5de36fbb7ee4e1abfda28a9912911f0330b34ea86841df4dce49
+  data.tar.gz: d716a1e9dfc4256469abb4ca963278f47583a8322ad9a4c0a6c00a66d6ad6b8fd84f718ce0461c7e54d90408eae947ac8941421914df8a4ef6b336762241c60a

data/.github/workflows/ci.yml

@@ -0,0 +1,35 @@
+name: CI
+
+on:
+  push:
+    branches: ["master"]
+  pull_request:
+    branches: ["master"]
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version:
+          - '2.1'
+          - '2.2'
+          - '2.3'
+          - '2.4'
+          - '2.5'
+          - '2.6'
+          - '2.7'
+    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/Gemfile

@@ -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

data/README.md

@@ -3,8 +3,9 @@ invoiced-ruby
 
 This repository contains the Ruby client library for the [Invoiced](https://invoiced.com) API.
 
-[![Build Status](https://travis-ci.org/Invoiced/invoiced-ruby.svg?branch=master)](https://travis-ci.org/Invoiced/invoiced-ruby)
+[![CI](https://github.com/Invoiced/invoiced-php/actions/workflows/ci.yml/badge.svg)](https://github.com/Invoiced/invoiced-php/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)
 
 ## Installing
 
@@ -44,10 +45,16 @@ Then, API calls can be made like this:
 invoice = invoiced.Invoice.retrieve("{INVOICE_ID}")
 
 # mark as paid
-transaction = invoiced.Transaction.create(
-    :invoice => invoice.id,
+payment = invoiced.Payment.create(
     :amount => invoice.balance,
-    :method => "check")
+    :method => "check",
+    :applied_to => [
+        {
+            :type => "invoice",
+            :invoice => invoice.id,
+            :amount => invoice.balance
+        }
+    ])
 ```
 
 If you want to use the sandbox API instead then you must set the second argument on the client to `true` like this:
@@ -66,4 +73,13 @@ 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`
+
+## Deploying
+
+The package can be uploaded to pypi with the following commands:
+
+```
+gem build invoiced.gemspec
+gem push invoiced-X.Y.Z.gem
+```

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/charge.rb

@@ -0,0 +1,12 @@
+module Invoiced
+    class Charge < Object
+        OBJECT_NAME = 'charge'
+
+        def create(body={}, opts={})
+            response = @client.request(:post, endpoint(), body, opts)
+
+            payment = Payment.new(@client)
+            Util.convert_to_object(payment, response[:body])
+        end
+    end
+end

data/lib/invoiced/credit_balance_adjustment.rb

@@ -0,0 +1,10 @@
+module Invoiced
+    class CreditBalanceAdjustment < Object
+        include Invoiced::Operations::List
+        include Invoiced::Operations::Create
+        include Invoiced::Operations::Update
+        include Invoiced::Operations::Delete
+
+        OBJECT_NAME = 'credit_balance_adjustment'
+    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/{catalog_item.rb → item.rb}

@@ -1,10 +1,10 @@
 module Invoiced
-    class CatalogItem < Object
+    class Item < Object
         include Invoiced::Operations::List
         include Invoiced::Operations::Create
         include Invoiced::Operations::Update
         include Invoiced::Operations::Delete
 
-        OBJECT_NAME = 'catalog_item'
+        OBJECT_NAME = 'item'
     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/{transaction.rb → payment.rb}

@@ -1,11 +1,11 @@
 module Invoiced
-    class Transaction < Object
+    class Payment < Object
         include Invoiced::Operations::List
         include Invoiced::Operations::Create
         include Invoiced::Operations::Update
         include Invoiced::Operations::Delete
 
-        OBJECT_NAME = 'transaction'
+        OBJECT_NAME = 'payment'
 
         def send(params={}, opts={})
             response = @client.request(:post, "#{self.endpoint()}/emails", params, opts)
@@ -14,17 +14,5 @@ module Invoiced
             email = Email.new(@client)
             Util.build_objects(email, response[:body])
         end
-
-        def refund(params={}, opts={})
-            response = @client.request(:post, "#{self.endpoint()}/refunds", params, opts)
-
-            Util.convert_to_object(self, response[:body])
-        end
-
-        def initiate_charge(params={}, opts={})
-            response = @client.request(:post, "/charges", params, opts)
-
-            Util.convert_to_object(self, response[:body])
-        end
     end
 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/refund.rb

@@ -0,0 +1,11 @@
+module Invoiced
+    class Refund < Object
+        OBJECT_NAME = 'refund'
+
+        def create(chargeId, body={}, opts={})
+            response = @client.request(:post, @endpoint_base + "/charges/#{chargeId}/refunds", body, opts)
+
+            Util.convert_to_object(self, response[:body])
+        end
+    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 = '1.1.0'
+  VERSION = '2.1.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,30 +19,52 @@ require 'invoiced/operations/update'
 
 require 'invoiced/object'
 require 'invoiced/payment_source_object'
+
 require 'invoiced/attachment'
 require 'invoiced/bank_account'
 require 'invoiced/card'
-require 'invoiced/catalog_item'
+require 'invoiced/charge'
 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/transaction'
+require 'invoiced/theme'
+require 'invoiced/webhook'
 
 module Invoiced
     class Client
@@ -53,7 +75,7 @@ module Invoiced
         ReadTimeout = 80
 
         attr_reader :api_key, :api_url, :sandbox, :sso_key
-        attr_reader :CatalogItem, :Coupon, :CreditNote, :Customer, :Estimate, :Event, :File, :Invoice, :Note, :Plan, :Subscription, :Task, :TaxRate, :Transaction
+        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
@@ -62,20 +84,41 @@ module Invoiced
           @sso_key = sso_key
 
           # Object endpoints
-          @CatalogItem = Invoiced::CatalogItem.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)
-          @Transaction = Invoiced::Transaction.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

@@ -0,0 +1,27 @@
+require File.expand_path('../../test_helper', __FILE__)
+
+module Invoiced
+  class ChargeTest < Test::Unit::TestCase
+    include Invoiced::Operations::EndpointTest
+
+    setup do
+      @objectClass = Charge
+      @endpoint = '/charges'
+    end
+
+    should "create a charge" do
+      mockResponse = mock('RestClient::Response')
+      mockResponse.stubs(:code).returns(201)
+      mockResponse.stubs(:body).returns('{"id":"a1b2c3","amount":100,"object":"charge"}')
+      mockResponse.stubs(:headers).returns({})
+
+      RestClient::Request.any_instance.expects(:execute).returns(mockResponse)
+
+      charge = Charge.new(@client, 1234)
+      payment = charge.create(:amount => 100, :payment_source_type => "card")
+
+      assert_instance_of(Invoiced::Payment, payment)
+      assert_equal(payment.id, "a1b2c3")
+    end
+  end
+end