invoiced 0.13.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: af3c9c33d3ab2a41846eec239e659b6a83567f1e
-  data.tar.gz: c27763abfd2ac362595eb44c9ff4afd067485346
+SHA256:
+  metadata.gz: 96fee7c8ec29ed8496d56e2ad01040962c4e793e03d8746cd1bb33dc9d455310
+  data.tar.gz: 24c4ac4cf3671312b13da58e7ffb0798041ff50572d06e49ccbab047f2fe7130
 SHA512:
-  metadata.gz: df10f784d4468a435fab99638180f213c30325cc0f40a695809b306bf3ebad5846804eb5a47d1f9a865ddc77ececf0694f634c28ff6fea45b1d102425a8aed7e
-  data.tar.gz: 5a0e7161ac5632520f9cf7c39e4f91ab2a2d39f47a4e240c8144e314fc22dc8a81839864da14a2bcc8e3b8f28d1b48101fe3e959de35eeec79673d0e19c95267
+  metadata.gz: f8a1fbde18532af461b0051de5a9a35beeefa4e6b9826cbbc65d8ce4ac73b91ce6d40d81c7b3d3fd6d68a989c74441cd0ee45d9cd1f8d9f1c7e50095a4666cd1
+  data.tar.gz: 79c75b2a9c9654ecf61a520aaa1e1bc3c2802d189b540238dd4556108c00255e0d88155f2d96200c11a8ddb870b4ee16be2e8fb0cd1b34e6e80597b7661b357d

data/.gitignore

@@ -1,4 +1,6 @@
 Gemfile.lock
 example.rb
 /invoiced-*.gem
-/coverage
+/coverage
+.DS_Store
+.idea/

data/.travis.yml

@@ -1,11 +1,13 @@
 language: ruby
 
 rvm:
-  - 2.0
   - 2.1
   - 2.2
   - 2.3
   - 2.4
+  - 2.5
+  - 2.6
+  - 2.7
 
 sudo: false
 

data/Gemfile

@@ -2,13 +2,12 @@ source "https://rubygems.org"
 gemspec
 
 gem 'rest-client', '~> 2.0.0'
-gem 'jwt', '~> 2.0.0'
+gem 'jwt', '~> 2.0'
 
 gem 'mocha', '~> 0.13.2', :require => false, :group => :test
 gem 'shoulda', '~> 3.4.0', :require => false, :group => :test
 gem 'test-unit', :require => false, :group => :test
 gem 'rake', :require => false, :group => :test
-gem 'activesupport', '~> 4.2.9', :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

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)
+[![Build Status](https://travis-ci.com/Invoiced/invoiced-ruby.svg?branch=master)](https://travis-ci.com/Invoiced/invoiced-ruby)
 [![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
 
@@ -24,8 +25,9 @@ gem 'invoiced'
 
 ## Requirements
 
-- Ruby 2.0+
-- rest_client gem
+- Ruby 2.1+
+- `rest_client` gem
+- `jwt` gem
 
 ## Usage
 
@@ -43,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:

data/invoiced.gemspec

@@ -12,10 +12,10 @@ 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.0.0'
+  s.required_ruby_version = '>= 2.1.0'
 
   s.add_dependency('rest-client', '~> 2.0.0')
-  s.add_dependency('jwt', '~> 2.0.0')
+  s.add_dependency('jwt', '~> 2.0')
 
   s.files = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- test/*`.split("\n")

data/lib/invoiced.rb

@@ -1,4 +1,5 @@
 require 'rest-client'
+require 'jwt'
 require 'json'
 require 'base64'
 
@@ -17,9 +18,14 @@ require 'invoiced/operations/delete'
 require 'invoiced/operations/update'
 
 require 'invoiced/object'
+require 'invoiced/payment_source_object'
 require 'invoiced/attachment'
-require 'invoiced/catalog_item'
+require 'invoiced/bank_account'
+require 'invoiced/card'
+require 'invoiced/item'
+require 'invoiced/charge'
 require 'invoiced/contact'
+require 'invoiced/coupon'
 require 'invoiced/credit_note'
 require 'invoiced/customer'
 require 'invoiced/email'
@@ -27,10 +33,18 @@ require 'invoiced/estimate'
 require 'invoiced/event'
 require 'invoiced/file'
 require 'invoiced/invoice'
+require 'invoiced/letter'
 require 'invoiced/line_item'
+require 'invoiced/note'
+require 'invoiced/payment'
 require 'invoiced/payment_plan'
+require 'invoiced/payment_source'
 require 'invoiced/plan'
+require 'invoiced/refund'
 require 'invoiced/subscription'
+require 'invoiced/task'
+require 'invoiced/tax_rate'
+require 'invoiced/text_message'
 require 'invoiced/transaction'
 
 module Invoiced
@@ -42,7 +56,7 @@ module Invoiced
         ReadTimeout = 80
 
         attr_reader :api_key, :api_url, :sandbox, :sso_key
-        attr_reader :CatalogItem, :CreditNote, :Customer, :Estimate, :Event, :File, :Invoice, :Plan, :Subscription, :Transaction
+        attr_reader :Item, :Charge, :Coupon, :CreditNote, :Customer, :Estimate, :Event, :File, :Invoice, :Note, :Payment, :Plan, :Refund, :Subscription, :Task, :TaxRate, :Transaction
 
         def initialize(api_key, sandbox=false, sso_key=false)
           @api_key = api_key
@@ -51,15 +65,22 @@ module Invoiced
           @sso_key = sso_key
 
           # Object endpoints
-          @CatalogItem = Invoiced::CatalogItem.new(self)
+          @Item = Invoiced::Item.new(self)
+          @Charge = Invoiced::Charge.new(self)
+          @Coupon = Invoiced::Coupon.new(self)
           @CreditNote = Invoiced::CreditNote.new(self)
           @Customer = Invoiced::Customer.new(self)
           @Estimate = Invoiced::Estimate.new(self)
           @Event = Invoiced::Event.new(self)
           @File = Invoiced::File.new(self)
           @Invoice = Invoiced::Invoice.new(self)
+          @Note = Invoiced::Note.new(self)
+          @Payment = Invoiced::Payment.new(self)
           @Plan = Invoiced::Plan.new(self)
+          @Refund = Invoiced::Refund.new(self)
           @Subscription = Invoiced::Subscription.new(self)
+          @Task = Invoiced::Task.new(self)
+          @TaxRate = Invoiced::TaxRate.new(self)
           @Transaction = Invoiced::Transaction.new(self)
         end
 
@@ -201,4 +222,4 @@ module Invoiced
             ApiError.new("API Error #{code} - #{body}", code)
         end
     end
-end
+end

data/lib/invoiced/bank_account.rb

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

data/lib/invoiced/card.rb

@@ -0,0 +1,6 @@
+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/{catalog_item.rb → coupon.rb}

@@ -1,10 +1,10 @@
 module Invoiced
-    class CatalogItem < Object
+    class Coupon < Object
         include Invoiced::Operations::List
         include Invoiced::Operations::Create
         include Invoiced::Operations::Update
         include Invoiced::Operations::Delete
 
-        OBJECT_NAME = 'catalog_item'
+        OBJECT_NAME = 'coupon'
     end
 end

data/lib/invoiced/credit_note.rb

@@ -35,5 +35,13 @@ module Invoiced
 
             return attachments, metadata
         end
+
+        def void()
+            response = @client.request(:post, "#{self.endpoint()}/void", {})
+
+            refresh_from(response[:body].dup.merge({:id => self.id}))
+
+            return response[:code] == 200
+        end
     end
 end

data/lib/invoiced/customer.rb

@@ -15,6 +15,22 @@ module Invoiced
             Util.build_objects(email, response[:body])
         end
 
+        def send_statement_sms(params={}, opts={})
+            response = @client.request(:post, "#{self.endpoint()}/text_messages", params, opts)
+
+            # build text message objects
+            text_message = TextMessage.new(@client)
+            Util.build_objects(text_message, response[:body])
+        end
+
+        def send_statement_letter(params={}, opts={})
+            response = @client.request(:post, "#{self.endpoint()}/letters", params, opts)
+
+            # build letter objects
+            letter = Letter.new(@client)
+            Util.build_objects(letter, response[:body])
+        end
+
         def balance
             response = @client.request(:get, "#{self.endpoint()}/balance")
 
@@ -26,11 +42,21 @@ module Invoiced
             contact.set_endpoint_base(self.endpoint())
         end
 
+        def payment_sources()
+            source = PaymentSource.new(@client)
+            source.set_endpoint_base(self.endpoint())
+        end
+
         def line_items()
             line = LineItem.new(@client)
             line.set_endpoint_base(self.endpoint())
         end
 
+        def list_notes()
+            note = Note.new(@client)
+            note.set_endpoint_base(self.endpoint())
+        end
+
         def invoice(params={}, opts={})
             response = @client.request(:post, "#{self.endpoint()}/invoices", params, opts)
 
@@ -38,5 +64,13 @@ module Invoiced
             invoice = Invoice.new(@client)
             Util.convert_to_object(invoice, response[:body])
         end
+
+        def consolidate_invoices(params={})
+            response = @client.request(:post, "#{self.endpoint()}/consolidate_invoices", params)
+
+            # build invoice object
+            invoice = Invoice.new(@client)
+            Util.convert_to_object(invoice, response[:body])
+        end
     end
 end

data/lib/invoiced/estimate.rb

@@ -43,5 +43,13 @@ module Invoiced
 
             return attachments, metadata
         end
+        
+        def void()
+            response = @client.request(:post, "#{self.endpoint()}/void", {})
+
+            refresh_from(response[:body].dup.merge({:id => self.id}))
+
+            return response[:code] == 200
+        end
     end
 end

data/lib/invoiced/invoice.rb

@@ -15,6 +15,23 @@ module Invoiced
             Util.build_objects(email, response[:body])
         end
 
+        def send_sms(params={}, opts={})
+            response = @client.request(:post, "#{self.endpoint()}/text_messages", params, opts)
+
+            # build text message objects
+            text_message = TextMessage.new(@client)
+            Util.build_objects(text_message, response[:body])
+        end
+
+        def send_letter(params={}, opts={})
+            response = @client.request(:post, "#{self.endpoint()}/letters", params, opts)
+
+            # build letter objects
+
+            letter = Letter.new(@client)
+            Util.build_objects(letter, response[:body])
+        end
+
         def pay(opts={})
             response = @client.request(:post, "#{self.endpoint()}/pay", {}, opts)
 
@@ -33,7 +50,7 @@ module Invoiced
                 if !attachment.has_key?(:id)
                     attachment[:id] = attachment[:file][:id]
                 end
-            end
+        end
 
             # build objects
             attachment = Attachment.new(@client)
@@ -49,5 +66,18 @@ module Invoiced
             paymentPlan = PaymentPlan.new(@client)
             paymentPlan.set_endpoint_base(self.endpoint())
         end
+
+        def notes()
+            note = Note.new(@client)
+            note.set_endpoint_base(self.endpoint())
+        end
+
+        def void()
+            response = @client.request(:post, "#{self.endpoint()}/void", {})
+
+            refresh_from(response[:body].dup.merge({:id => self.id}))
+
+            return response[:code] == 200
+        end
     end
 end

data/lib/invoiced/item.rb

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

data/lib/invoiced/letter.rb

@@ -0,0 +1,5 @@
+module Invoiced
+    class Letter < Object
+        OBJECT_NAME = 'letter'
+    end
+end

data/lib/invoiced/note.rb

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

data/lib/invoiced/object.rb

@@ -46,7 +46,7 @@ module Invoiced
                 raise ArgumentError.new("Missing ID.")
             end
 
-            response = @client.request(:get, "#{self.endpoint()}/#{id}", params)
+            response = @client.request(:get, "#{endpoint()}/#{id}", params)
 
             Util.convert_to_object(self, response[:body])
         end
@@ -57,7 +57,7 @@ module Invoiced
 
         def inspect
             id_string = (!@id.nil?) ? " id=#{@id}" : ""
-            "#<#{self.class}:0x#{self.object_id.to_s(16)}#{id_string}> JSON: " + JSON.pretty_generate(@values)
+            "#<#{self.class}:0x#{object_id.to_s(16)}#{id_string}> JSON: " + JSON.pretty_generate(@values)
         end
 
         def refresh_from(values)

data/lib/invoiced/operations/create.rb

@@ -2,7 +2,7 @@ module Invoiced
     module Operations
         module Create
             def create(body={}, opts={})
-                response = @client.request(:post, self.endpoint(), body, opts)
+                response = @client.request(:post, endpoint(), body, opts)
 
                 Util.convert_to_object(self, response[:body])
             end

data/lib/invoiced/payment.rb

@@ -0,0 +1,18 @@
+module Invoiced
+    class Payment < Object
+        include Invoiced::Operations::List
+        include Invoiced::Operations::Create
+        include Invoiced::Operations::Update
+        include Invoiced::Operations::Delete
+
+        OBJECT_NAME = 'payment'
+
+        def send(params={}, opts={})
+            response = @client.request(:post, "#{self.endpoint()}/emails", params, opts)
+
+            # build email objects
+            email = Email.new(@client)
+            Util.build_objects(email, response[:body])
+        end
+    end
+end