invoiced 0.12.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5997cf1ddd23e0cece25a26780c348354a672b9c
-  data.tar.gz: 7f0a09349c1b87b9cfb11c8afbdf6533a566cdd2
+SHA256:
+  metadata.gz: 3c9a2f8ec999dc38fc2d99a9a6c70ed9f908453399e7a1391b139f08d0016c58
+  data.tar.gz: bded9ce98e08adf08061d9411958f358c2a53622f1c6df96ddbdee4ea34c02b8
 SHA512:
-  metadata.gz: cf0aa2c91593969dfe034a8f6f5db01fe6e7ee7164c0327ddd67de29c968b2378311af6ccbae253d90f75be240491cda23fa8bb3d3b09bc351ef9ce2a27cabdf
-  data.tar.gz: 9c936769e5d820574fdfef68e508454c1aa0fba468a602bfc4bc1e49edba3dcad2a2d4f8ca27fe92d2f2a546d6a55a45ecf58783b1bcfcb8541cbb43cf95dca4
+  metadata.gz: cce64c5c13a67dcfb8d1b693fa915e3927b9785a4f27c9a19dd72c0c36e9b97ad17b1159a0023994d73562e90d8cd0384f51704c890e8f2e849d9e8b9f1a3800
+  data.tar.gz: 9763afc75104c54d36b1a31cf603d9fd13d8a777b17f3d871cb59eadc8b80fa1e0ebfd2bdfd68de52110e27fd6a35c73a29c4f34fafc0b647386a6073bb17b91

data/.gitignore

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

data/.travis.yml

@@ -1,9 +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

@@ -1,9 +1,13 @@
 source "https://rubygems.org"
 gemspec
 
-gem 'json', '~> 1.8.3'
 gem 'rest-client', '~> 2.0.0'
-gem 'activesupport', '~> 4.2.3'
+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 '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

@@ -5,6 +5,7 @@ This repository contains the Ruby client library for the [Invoiced](https://invo
 
 [![Build Status](https://travis-ci.org/Invoiced/invoiced-ruby.svg?branch=master)](https://travis-ci.org/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, json, and active_support gems
+- Ruby 2.1+
+- `rest_client` gem
+- `jwt` gem
 
 ## Usage
 

data/invoiced.gemspec

@@ -12,16 +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('json', '~> 1.8.3')
-  s.add_dependency('activesupport', '~> 4.2.3')
-
-  s.add_development_dependency('mocha', '~> 0.13.2')
-  s.add_development_dependency('shoulda', '~> 3.4.0')
-  s.add_development_dependency('test-unit')
-  s.add_development_dependency('rake')
+  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,7 +1,7 @@
 require 'rest-client'
+require 'jwt'
 require 'json'
 require 'base64'
-require 'active_support/inflector'
 
 require 'invoiced/version'
 require 'invoiced/util'
@@ -18,9 +18,14 @@ require 'invoiced/operations/delete'
 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_note'
 require 'invoiced/customer'
 require 'invoiced/email'
@@ -28,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,24 +55,32 @@ module Invoiced
         OpenTimeout = 30
         ReadTimeout = 80
 
-        attr_reader :api_key, :api_url, :sandbox
-        attr_reader :CatalogItem, :CreditNote, :Customer, :Estimate, :Event, :File, :Invoice, :Plan, :Subscription, :Transaction
+        attr_reader :api_key, :api_url, :sandbox, :sso_key
+        attr_reader :CatalogItem, :Charge, :Coupon, :CreditNote, :Customer, :Estimate, :Event, :File, :Invoice, :Note, :Payment, :Plan, :Refund, :Subscription, :Task, :TaxRate, :Transaction
 
-        def initialize(api_key, sandbox=false)
+        def initialize(api_key, sandbox=false, sso_key=false)
           @api_key = api_key
           @sandbox = sandbox
           @api_url = sandbox ? ApiBaseSandbox : ApiBase
+          @sso_key = sso_key
 
           # Object endpoints
           @CatalogItem = Invoiced::CatalogItem.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
 
@@ -97,6 +118,23 @@ module Invoiced
             parse(response)
         end
 
+        def generate_sign_in_token(customerId, ttl)
+            if !@sso_key
+                raise "Please provide a single sign-on key! You can find this value in Settings > Developers > Single Sign-On of the Invoiced application."
+            end
+
+            expires = Time.now + ttl # TTL should be in seconds
+
+            payload = {
+                :sub => customerId,
+                :iss => "Invoiced Ruby/#{Invoiced::VERSION}",
+                :iat => Time.now.to_i,
+                :exp => expires.to_i
+            }
+
+            JWT.encode payload, @sso_key, 'HS256'
+        end
+
         private
 
         def buildHeaders(opts)
@@ -184,4 +222,4 @@ module Invoiced
             ApiError.new("API Error #{code} - #{body}", code)
         end
     end
-end
+end

data/lib/invoiced/attachment.rb

@@ -1,4 +1,5 @@
 module Invoiced
     class Attachment < Object
+        OBJECT_NAME = 'attachment'
     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/catalog_item.rb

@@ -4,5 +4,7 @@ module Invoiced
         include Invoiced::Operations::Create
         include Invoiced::Operations::Update
         include Invoiced::Operations::Delete
+
+        OBJECT_NAME = 'catalog_item'
     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/contact.rb

@@ -4,5 +4,7 @@ module Invoiced
         include Invoiced::Operations::Create
         include Invoiced::Operations::Update
         include Invoiced::Operations::Delete
+
+        OBJECT_NAME = 'contact'
     end
 end

data/lib/invoiced/coupon.rb

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

data/lib/invoiced/credit_note.rb

@@ -5,6 +5,8 @@ module Invoiced
         include Invoiced::Operations::Update
         include Invoiced::Operations::Delete
 
+        OBJECT_NAME = 'credit_note'
+
         def send(params={}, opts={})
             response = @client.request(:post, "#{self.endpoint()}/emails", params, opts)
 
@@ -33,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

@@ -5,6 +5,8 @@ module Invoiced
         include Invoiced::Operations::Update
         include Invoiced::Operations::Delete
 
+        OBJECT_NAME = 'customer'
+
         def send_statement(params={}, opts={})
             response = @client.request(:post, "#{self.endpoint()}/emails", params, opts)
 
@@ -13,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")
 
@@ -24,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)
 
@@ -36,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/email.rb

@@ -1,4 +1,5 @@
 module Invoiced
     class Email < Object
+        OBJECT_NAME = 'email'
     end
 end

data/lib/invoiced/estimate.rb

@@ -5,6 +5,8 @@ module Invoiced
         include Invoiced::Operations::Update
         include Invoiced::Operations::Delete
 
+        OBJECT_NAME = 'estimate'
+
         def send(params={}, opts={})
             response = @client.request(:post, "#{self.endpoint()}/emails", params, opts)
 
@@ -41,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/event.rb

@@ -1,5 +1,7 @@
 module Invoiced
     class Event < Object
         include Invoiced::Operations::List
+
+        OBJECT_NAME = 'event'
     end
 end

data/lib/invoiced/file.rb

@@ -2,5 +2,7 @@ module Invoiced
     class File < Object
         include Invoiced::Operations::Create
         include Invoiced::Operations::Delete
+
+        OBJECT_NAME = 'file'
     end
 end

data/lib/invoiced/invoice.rb

@@ -5,6 +5,8 @@ module Invoiced
         include Invoiced::Operations::Update
         include Invoiced::Operations::Delete
 
+        OBJECT_NAME = 'invoice'
+
         def send(params={}, opts={})
             response = @client.request(:post, "#{self.endpoint()}/emails", params, opts)
 
@@ -13,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)
 
@@ -31,7 +50,7 @@ module Invoiced
                 if !attachment.has_key?(:id)
                     attachment[:id] = attachment[:file][:id]
                 end
-            end
+        end
 
             # build objects
             attachment = Attachment.new(@client)
@@ -47,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