invoiced 0.12.0 → 1.2.0

data/lib/invoiced/letter.rb

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

data/lib/invoiced/line_item.rb

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

@@ -8,10 +8,8 @@ module Invoiced
 
         def initialize(client, id=nil, values={})
             @client = client
-            class_name = self.class.name.split('::').last
             @endpoint_base = ''
-            @endpoint = '/' + class_name.underscore.pluralize.downcase
-
+            @endpoint = build_endpoint
             @id = id
             @values = {}
 
@@ -35,12 +33,20 @@ module Invoiced
             @endpoint_base + @endpoint
         end
 
+        def build_endpoint
+            if self.class.const_defined? "OBJECT_NAME"
+                '/' + self.class::OBJECT_NAME + 's'
+            else
+                '/objects'
+            end
+        end
+
         def retrieve(id, params={})
             if !id
                 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
@@ -51,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

data/lib/invoiced/payment_plan.rb

@@ -2,6 +2,8 @@ module Invoiced
     class PaymentPlan < Object
         include Invoiced::Operations::Delete
 
+        OBJECT_NAME = 'payment_plan'
+
         def initialize(client, id=nil, values={})
         	super
         	@endpoint = '/payment_plan'

data/lib/invoiced/payment_source.rb

@@ -0,0 +1,8 @@
+module Invoiced
+  class PaymentSource < Object
+    include Invoiced::Operations::Create
+    include Invoiced::Operations::List
+
+    OBJECT_NAME = 'payment_source'
+  end
+end

data/lib/invoiced/payment_source_object.rb

@@ -0,0 +1,5 @@
+module Invoiced
+    class PaymentSourceObject < Object
+        include Invoiced::Operations::Delete
+    end
+end

data/lib/invoiced/plan.rb

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

@@ -5,8 +5,16 @@ module Invoiced
         include Invoiced::Operations::Update
         include Invoiced::Operations::Delete
 
+        OBJECT_NAME = 'subscription'
+
         def cancel
             delete
         end
+
+        def preview(params={}, opts={})
+            response = @client.request(:post, "/subscriptions/preview", params, opts)
+
+            response[:body]
+        end
     end
 end

data/lib/invoiced/task.rb

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

data/lib/invoiced/tax_rate.rb

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

data/lib/invoiced/text_message.rb

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

data/lib/invoiced/transaction.rb

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

@@ -17,7 +17,19 @@ module Invoiced
             end
 
             def convert_to_object(_class, values)
-                object = _class.class.new(_class.client, values[:id], values)
+                object_class = _class.class
+
+                # check for PaymentSource special case where class must be forced to Card or BankAccount
+                unless values[:object].nil?
+                    if values[:object] == 'card'
+                        object_class = Invoiced::Card
+                    elsif values[:object] == 'bank_account'
+                        object_class = Invoiced::BankAccount
+                    end
+                end
+
+                object = object_class.new(_class.client, values[:id], values)
+
                 object.set_endpoint_base(_class.endpoint_base())
             end
 

data/lib/invoiced/version.rb

@@ -1,3 +1,3 @@
 module Invoiced
-  VERSION = '0.12.0'
+  VERSION = '1.2.0'
 end

data/test/invoiced/charge_test.rb

@@ -0,0 +1,25 @@
+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())
+    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)
+      charge = charge.create(:amount => 100, :payment_source_type => "card")
+
+      assert_instance_of(Invoiced::Payment, charge)
+      assert_equal(charge.id, "a1b2c3")
+    end
+  end
+end

data/test/invoiced/coupon_test.rb

@@ -0,0 +1,90 @@
+require File.expand_path('../../test_helper', __FILE__)
+
+module Invoiced
+  class CouponTest < Test::Unit::TestCase
+    should "return the api endpoint" do
+      coupon = Coupon.new(@client, "test")
+      assert_equal('/coupons/test', coupon.endpoint())
+    end
+
+    should "create a coupon" do
+      mockResponse = mock('RestClient::Response')
+      mockResponse.stubs(:code).returns(201)
+      mockResponse.stubs(:body).returns('{"id":"test","name":"Test Coupon"}')
+      mockResponse.stubs(:headers).returns({})
+
+      RestClient::Request.any_instance.expects(:execute).returns(mockResponse)
+
+      coupon = @client.Coupon.create({:name => "Test Coupon"})
+
+      assert_instance_of(Invoiced::Coupon, coupon)
+      assert_equal("test", coupon.id)
+      assert_equal('Test Coupon', coupon.name)
+    end
+
+    should "retrieve a coupon" do
+      mockResponse = mock('RestClient::Response')
+      mockResponse.stubs(:code).returns(200)
+      mockResponse.stubs(:body).returns('{"id":"test","name":"Test Coupon"}')
+      mockResponse.stubs(:headers).returns({})
+
+      RestClient::Request.any_instance.expects(:execute).returns(mockResponse)
+
+      coupon = @client.Coupon.retrieve("test")
+
+      assert_instance_of(Invoiced::Coupon, coupon)
+      assert_equal("test", coupon.id)
+      assert_equal('Test Coupon', coupon.name)
+    end
+
+    should "not update a coupon when no params" do
+      coupon = Coupon.new(@client, "test")
+      assert_false(coupon.save)
+    end
+
+    should "update a coupon" do
+      mockResponse = mock('RestClient::Response')
+      mockResponse.stubs(:code).returns(200)
+      mockResponse.stubs(:body).returns('{"id":"test","name":"Testing Coupon"}')
+      mockResponse.stubs(:headers).returns({})
+
+      RestClient::Request.any_instance.expects(:execute).returns(mockResponse)
+
+      coupon = Coupon.new(@client, "test")
+      coupon.name = "Testing Coupon"
+      assert_true(coupon.save)
+
+      assert_equal(coupon.name, "Testing Coupon")
+    end
+
+    should "list all coupons" do
+      mockResponse = mock('RestClient::Response')
+      mockResponse.stubs(:code).returns(200)
+      mockResponse.stubs(:body).returns('[{"id":"test","name":"Test Coupon"}]')
+      mockResponse.stubs(:headers).returns(:x_total_count => 15, :link => '<https://api.invoiced.com/catalog_items?per_page=25&page=1>; rel="self", <https://api.invoiced.com/catalog_items?per_page=25&page=1>; rel="first", <https://api.invoiced.com/catalog_items?per_page=25&page=1>; rel="last"')
+
+      RestClient::Request.any_instance.expects(:execute).returns(mockResponse)
+
+      coupons, metadata = @client.Coupon.list
+
+      assert_instance_of(Array, coupons)
+      assert_equal(1, coupons.length)
+      assert_equal("test", coupons[0].id)
+
+      assert_instance_of(Invoiced::List, metadata)
+      assert_equal(15, metadata.total_count)
+    end
+
+    should "delete a coupon" 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)
+
+      coupon = Coupon.new(@client, "test")
+      assert_true(coupon.delete)
+    end
+  end
+end

data/test/invoiced/credit_note_test.rb

@@ -122,5 +122,19 @@ module Invoiced
       assert_instance_of(Invoiced::List, metadata)
       assert_equal(10, metadata.total_count)
     end
+
+    should "void a credit note" do
+      mockResponse = mock('RestClient::Response')
+      mockResponse.stubs(:code).returns(200)
+      mockResponse.stubs(:body).returns('{"id":123,"status":"voided"}')
+      mockResponse.stubs(:headers).returns({})
+
+      RestClient::Request.any_instance.expects(:execute).returns(mockResponse)
+
+      credit_note = CreditNote.new(@client, 123)
+      assert_true(credit_note.void)
+
+      assert_equal(credit_note.status, 'voided')
+    end
   end
 end

data/test/invoiced/customer_test.rb

@@ -87,7 +87,7 @@ module Invoiced
       assert_true(customer.delete)
     end
 
-    should "send an account statement" do
+    should "send an account statement by email" do
       mockResponse = mock('RestClient::Response')
       mockResponse.stubs(:code).returns(201)
       mockResponse.stubs(:body).returns('[{"id":4567,"email":"test@example.com"}]')
@@ -104,6 +104,40 @@ module Invoiced
       assert_equal(4567, emails[0].id)
     end
 
+    should "send an account statement by text message" do
+      mockResponse = mock('RestClient::Response')
+      mockResponse.stubs(:code).returns(201)
+      mockResponse.stubs(:body).returns('[{"id":5678,"state":"sent"}]')
+      mockResponse.stubs(:headers).returns({})
+
+      RestClient::Request.any_instance.expects(:execute).returns(mockResponse)
+
+      customer = Customer.new(@client, 123)
+      text_messages = customer.send_statement_sms(:type => "open_item", :message => "example")
+
+      assert_instance_of(Array, text_messages)
+      assert_equal(1, text_messages.length)
+      assert_instance_of(Invoiced::TextMessage, text_messages[0])
+      assert_equal(5678, text_messages[0].id)
+    end
+
+    should "send an account statement by letter" do
+      mockResponse = mock('RestClient::Response')
+      mockResponse.stubs(:code).returns(201)
+      mockResponse.stubs(:body).returns('[{"id":6789,"state":"queued"}]')
+      mockResponse.stubs(:headers).returns({})
+
+      RestClient::Request.any_instance.expects(:execute).returns(mockResponse)
+
+      customer = Customer.new(@client, 123)
+      letters = customer.send_statement_letter(:type => "open_item")
+
+      assert_instance_of(Array, letters)
+      assert_equal(1, letters.length)
+      assert_instance_of(Invoiced::Letter, letters[0])
+      assert_equal(6789, letters[0].id)
+    end
+
     should "retrieve a customer's balance" do
       mockResponse = mock('RestClient::Response')
       mockResponse.stubs(:code).returns(200)
@@ -141,7 +175,7 @@ module Invoiced
       assert_equal('/customers/456/contacts/123', contact.endpoint())
     end
 
-    should "list all of the customer's contact" do
+    should "list all of the customer's contacts" do
       mockResponse = mock('RestClient::Response')
       mockResponse.stubs(:code).returns(200)
       mockResponse.stubs(:body).returns('[{"id":123,"name":"Nancy"}]')
@@ -246,5 +280,70 @@ module Invoiced
       assert_instance_of(Invoiced::Invoice, invoice)
       assert_equal(4567, invoice.id)
     end
+
+    should "list all the customer's notes" do
+      mockResponse = mock('RestClient::Response')
+      mockResponse.stubs(:code).returns(200)
+      mockResponse.stubs(:body).returns('[{"id":1212,"notes":"example"}]')
+      mockResponse.stubs(:headers).returns(:x_total_count => 15, :link => '<https://api.invoiced.com/customers/123/notes?per_page=25&page=1>; rel="self", <https://api.invoiced.com/customers/123/notes?per_page=25&page=1>; rel="first", <https://api.invoiced.com/customers/123/notes?per_page=25&page=1>; rel="last"')
+
+      RestClient::Request.any_instance.expects(:execute).returns(mockResponse)
+
+      customer = Customer.new(@client, 123)
+      notes, metadata = customer.list_notes.list
+
+      assert_instance_of(Array, notes)
+      assert_equal(1, notes.length)
+      assert_equal(1212, notes[0].id)
+      assert_equal('/customers/123/notes/1212', notes[0].endpoint())
+
+      assert_instance_of(Invoiced::List, metadata)
+      assert_equal(15, metadata.total_count)
+    end
+
+    should "create a consolidated invoice" do
+      mockResponse = mock('RestClient::Response')
+      mockResponse.stubs(:code).returns(201)
+      mockResponse.stubs(:body).returns('{"id": 999,"total":1000}')
+      mockResponse.stubs(:headers).returns({})
+
+      RestClient::Request.any_instance.expects(:execute).returns(mockResponse)
+
+      customer = Customer.new(@client, 123)
+      invoice = customer.consolidate_invoices
+
+      assert_instance_of(Invoiced::Invoice, invoice)
+      assert_equal(invoice.id, 999)
+    end
+
+    should "create a bank account associated with customer" do
+      mockResponse = mock('RestClient::Response')
+      mockResponse.stubs(:code).returns(201)
+      mockResponse.stubs(:body).returns('{"id": 999,"object":"bank_account"}')
+      mockResponse.stubs(:headers).returns({})
+
+      RestClient::Request.any_instance.expects(:execute).returns(mockResponse)
+
+      customer = Customer.new(@client, 123)
+      account = customer.payment_sources.create
+
+      assert_instance_of(Invoiced::BankAccount, account)
+      assert_equal(account.endpoint, "/customers/123/bank_accounts/999")
+    end
+
+    should "create a card associated with customer" do
+      mockResponse = mock('RestClient::Response')
+      mockResponse.stubs(:code).returns(201)
+      mockResponse.stubs(:body).returns('{"id": 888,"object":"card"}')
+      mockResponse.stubs(:headers).returns({})
+
+      RestClient::Request.any_instance.expects(:execute).returns(mockResponse)
+
+      customer = Customer.new(@client, 123)
+      card = customer.payment_sources.create
+
+      assert_instance_of(Invoiced::Card, card)
+      assert_equal(card.endpoint, "/customers/123/cards/888")
+    end
   end
 end