invoiced 0.7.0 → 0.8.0

data/lib/invoiced.rb

@@ -19,8 +19,10 @@ require 'invoiced/operations/update'
 require 'invoiced/object'
 require 'invoiced/attachment'
 require 'invoiced/contact'
+require 'invoiced/credit_note'
 require 'invoiced/customer'
 require 'invoiced/email'
+require 'invoiced/estimate'
 require 'invoiced/event'
 require 'invoiced/file'
 require 'invoiced/invoice'
@@ -29,114 +31,116 @@ require 'invoiced/subscription'
 require 'invoiced/transaction'
 
 module Invoiced
-	class Client
-		ApiBase = 'https://api.invoiced.com'
-		ApiBaseSandbox = 'https://api.sandbox.invoiced.com'
-
-		attr_reader :api_key, :api_url, :sandbox
-		attr_reader :Customer, :Event, :File, :Invoice, :Subscription, :Transaction
-
-	    def initialize(api_key, sandbox=false)
-	      @api_key = api_key
-	      @sandbox = sandbox
-	      @api_url = sandbox ? ApiBaseSandbox : ApiBase
-
-	      # Object endpoints
-	      @Customer = Invoiced::Customer.new(self)
-	      @Event = Invoiced::Event.new(self)
-	      @File = Invoiced::File.new(self)
-	      @Invoice = Invoiced::Invoice.new(self)
-	      @Subscription = Invoiced::Subscription.new(self)
-	      @Transaction = Invoiced::Transaction.new(self)
-	    end
-
-	    def request(method, endpoint, params={})
-	    	url = @api_url + endpoint
-
-			case method.to_s.downcase.to_sym
-			# These methods don't have a request body
-			when :get, :head, :delete
-				# Make params into GET parameters
-				url += "#{URI.parse(url).query ? '&' : '?'}#{Util.uri_encode(params)}" if params && params.any?
-				payload = nil
-			# Otherwise, encode request body to JSON
-			else
-				payload = params.to_json
-			end
-
-			begin
-		    	response = RestClient::Request.execute(
-		    		:method => method,
-		    		:url => url,
-		    		:headers => {
-		    			:authorization => Util.auth_header(@api_key),
-		    			:content_type => "application/json",
-		    			:user_agent => "Invoiced Ruby/#{Invoiced::VERSION}"
-		    		},
-		    		:payload => payload
-		    	)
-		    rescue RestClient::Exception => e
-		    	if e.response
-		    		rescue_api_error(e.response)
-		    	else
-		    		rescue_rest_client_error(e)
-		    	end
-		    end
-
-		    parse(response)
-	    end
-
-	    private
-
-	    def parse(response)
-	    	unless response.code == 204
-	    		parsed_response = JSON.parse(response.body, :symbolize_names => true)
-	    	else
-	    		parsed_response = nil
-	    	end
-
-	    	{
-	    		:code => response.code,
-	    		:headers => response.headers,
-	    		:body => parsed_response
-	    	}
-	    end
-
-	    def rescue_api_error(response)
-		    begin
-				error = JSON.parse(response.body)
-			rescue JSON::ParserError
-				raise general_api_error(response.code, response.body)
-			end
-
-			case response.code
-			when 400, 403, 404
-				raise invalid_request_error(error, response)
-			when 401
-				raise authentication_error(error, response)
-			else
-				raise api_error(error, response)
-			end
-	    end
-
-	    def rescue_rest_client_error(error)
-	    	raise ApiConnectionError.new("There was an error connecting to Invoiced.")
-	    end
-
-	    def authentication_error(error, response)
-	    	AuthenticationError.new(error["message"], response.code, error)
-	    end
-
-	    def invalid_request_error(error, response)
-	    	InvalidRequestError.new(error["message"], response.code, error)
-	    end
-
-	    def api_error(error, response)
-	    	ApiError.new(error["message"], response.code, error)
-	    end
-
-	    def general_api_error(code, body)
-	    	ApiError.new("API Error #{code} - #{body}", code)
-	    end
-	end
+    class Client
+        ApiBase = 'https://api.invoiced.com'
+        ApiBaseSandbox = 'https://api.sandbox.invoiced.com'
+
+        attr_reader :api_key, :api_url, :sandbox
+        attr_reader :CreditNote, :Customer, :Estimate, :Event, :File, :Invoice, :Subscription, :Transaction
+
+        def initialize(api_key, sandbox=false)
+          @api_key = api_key
+          @sandbox = sandbox
+          @api_url = sandbox ? ApiBaseSandbox : ApiBase
+
+          # Object endpoints
+          @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)
+          @Subscription = Invoiced::Subscription.new(self)
+          @Transaction = Invoiced::Transaction.new(self)
+        end
+
+        def request(method, endpoint, params={})
+            url = @api_url + endpoint
+
+            case method.to_s.downcase.to_sym
+            # These methods don't have a request body
+            when :get, :head, :delete
+                # Make params into GET parameters
+                url += "#{URI.parse(url).query ? '&' : '?'}#{Util.uri_encode(params)}" if params && params.any?
+                payload = nil
+            # Otherwise, encode request body to JSON
+            else
+                payload = params.to_json
+            end
+
+            begin
+                response = RestClient::Request.execute(
+                    :method => method,
+                    :url => url,
+                    :headers => {
+                        :authorization => Util.auth_header(@api_key),
+                        :content_type => "application/json",
+                        :user_agent => "Invoiced Ruby/#{Invoiced::VERSION}"
+                    },
+                    :payload => payload
+                )
+            rescue RestClient::Exception => e
+                if e.response
+                    rescue_api_error(e.response)
+                else
+                    rescue_rest_client_error(e)
+                end
+            end
+
+            parse(response)
+        end
+
+        private
+
+        def parse(response)
+            unless response.code == 204
+                parsed_response = JSON.parse(response.body, :symbolize_names => true)
+            else
+                parsed_response = nil
+            end
+
+            {
+                :code => response.code,
+                :headers => response.headers,
+                :body => parsed_response
+            }
+        end
+
+        def rescue_api_error(response)
+            begin
+                error = JSON.parse(response.body)
+            rescue JSON::ParserError
+                raise general_api_error(response.code, response.body)
+            end
+
+            case response.code
+            when 400, 403, 404
+                raise invalid_request_error(error, response)
+            when 401
+                raise authentication_error(error, response)
+            else
+                raise api_error(error, response)
+            end
+        end
+
+        def rescue_rest_client_error(error)
+            raise ApiConnectionError.new("There was an error connecting to Invoiced.")
+        end
+
+        def authentication_error(error, response)
+            AuthenticationError.new(error["message"], response.code, error)
+        end
+
+        def invalid_request_error(error, response)
+            InvalidRequestError.new(error["message"], response.code, error)
+        end
+
+        def api_error(error, response)
+            ApiError.new(error["message"], response.code, error)
+        end
+
+        def general_api_error(code, body)
+            ApiError.new("API Error #{code} - #{body}", code)
+        end
+    end
 end

data/test/invoiced/credit_note_test.rb

@@ -0,0 +1,126 @@
+require File.expand_path('../../test_helper', __FILE__)
+
+module Invoiced
+  class CreditNoteTest < Test::Unit::TestCase
+    should "return the api endpoint" do
+      creditNote = CreditNote.new(@client, 123)
+      assert_equal('/credit_notes/123', creditNote.endpoint())
+    end
+
+    should "create a credit note" do
+      mockResponse = mock('RestClient::Response')
+      mockResponse.stubs(:code).returns(201)
+      mockResponse.stubs(:body).returns('{"id":123,"number":"CN-0001"}')
+      mockResponse.stubs(:headers).returns({})
+
+      RestClient::Request.any_instance.expects(:execute).returns(mockResponse)
+
+      creditNote = @client.CreditNote.create({:number => "CN-0001"})
+
+      assert_instance_of(Invoiced::CreditNote, creditNote)
+      assert_equal(123, creditNote.id)
+      assert_equal('CN-0001', creditNote.number)
+    end
+
+    should "retrieve a credit note" do
+      mockResponse = mock('RestClient::Response')
+      mockResponse.stubs(:code).returns(200)
+      mockResponse.stubs(:body).returns('{"id":123,"number":"CN-0001"}')
+      mockResponse.stubs(:headers).returns({})
+
+      RestClient::Request.any_instance.expects(:execute).returns(mockResponse)
+
+      creditNote = @client.CreditNote.retrieve(123)
+
+      assert_instance_of(Invoiced::CreditNote, creditNote)
+      assert_equal(123, creditNote.id)
+      assert_equal('CN-0001', creditNote.number)
+    end
+
+    should "not update a credit note when no params" do
+      creditNote = CreditNote.new(@client, 123)
+      assert_false(creditNote.save)
+    end
+
+    should "update a credit note" do
+      mockResponse = mock('RestClient::Response')
+      mockResponse.stubs(:code).returns(200)
+      mockResponse.stubs(:body).returns('{"id":123,"closed":true}')
+      mockResponse.stubs(:headers).returns({})
+
+      RestClient::Request.any_instance.expects(:execute).returns(mockResponse)
+
+      creditNote = CreditNote.new(@client, 123)
+      creditNote.closed = true
+      assert_true(creditNote.save)
+
+      assert_true(creditNote.closed)
+    end
+
+    should "list all credit notes" do
+      mockResponse = mock('RestClient::Response')
+      mockResponse.stubs(:code).returns(200)
+      mockResponse.stubs(:body).returns('[{"id":123,"number":"CN-0001"}]')
+      mockResponse.stubs(:headers).returns(:x_total_count => 15, :link => '<https://api.invoiced.com/credit_notes?per_page=25&page=1>; rel="self", <https://api.invoiced.com/credit_notes?per_page=25&page=1>; rel="first", <https://api.invoiced.com/credit_notes?per_page=25&page=1>; rel="last"')
+
+      RestClient::Request.any_instance.expects(:execute).returns(mockResponse)
+
+      creditNotes, metadata = @client.CreditNote.list
+
+      assert_instance_of(Array, creditNotes)
+      assert_equal(1, creditNotes.length)
+      assert_equal(123, creditNotes[0].id)
+
+      assert_instance_of(Invoiced::List, metadata)
+      assert_equal(15, metadata.total_count)
+    end
+
+    should "delete a credit note" 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)
+
+      creditNote = CreditNote.new(@client, 123)
+      assert_true(creditNote.delete)
+    end
+
+    should "send a credit note" do
+      mockResponse = mock('RestClient::Response')
+      mockResponse.stubs(:code).returns(201)
+      mockResponse.stubs(:body).returns('[{"id":4567,"email":"test@example.com"}]')
+      mockResponse.stubs(:headers).returns({})
+
+      RestClient::Request.any_instance.expects(:execute).returns(mockResponse)
+
+      creditNote = CreditNote.new(@client, 1234)
+      emails = creditNote.send
+
+      assert_instance_of(Array, emails)
+      assert_equal(1, emails.length)
+      assert_instance_of(Invoiced::Email, emails[0])
+      assert_equal(4567, emails[0].id)
+    end
+
+    should "list all of the credit note's attachments" do
+      mockResponse = mock('RestClient::Response')
+      mockResponse.stubs(:code).returns(200)
+      mockResponse.stubs(:body).returns('[{"file":{"id":456}}]')
+      mockResponse.stubs(:headers).returns(:x_total_count => 10, :link => '<https://api.invoiced.com/credit_notes/123/attachments?per_page=25&page=1>; rel="self", <https://api.invoiced.com/credit_notes/123/attachments?per_page=25&page=1>; rel="first", <https://api.invoiced.com/credit_notes/123/attachments?per_page=25&page=1>; rel="last"')
+
+      RestClient::Request.any_instance.expects(:execute).returns(mockResponse)
+
+      creditNote = CreditNote.new(@client, 123)
+      attachments, metadata = creditNote.attachments
+
+      assert_instance_of(Array, attachments)
+      assert_equal(1, attachments.length)
+      assert_equal(456, attachments[0].id)
+
+      assert_instance_of(Invoiced::List, metadata)
+      assert_equal(10, metadata.total_count)
+    end
+  end
+end

data/test/invoiced/estimate_test.rb

@@ -0,0 +1,126 @@
+require File.expand_path('../../test_helper', __FILE__)
+
+module Invoiced
+  class EstimateTest < Test::Unit::TestCase
+    should "return the api endpoint" do
+      estimate = Estimate.new(@client, 123)
+      assert_equal('/estimates/123', estimate.endpoint())
+    end
+
+    should "create an estimate" do
+      mockResponse = mock('RestClient::Response')
+      mockResponse.stubs(:code).returns(201)
+      mockResponse.stubs(:body).returns('{"id":123,"number":"EST-0001"}')
+      mockResponse.stubs(:headers).returns({})
+
+      RestClient::Request.any_instance.expects(:execute).returns(mockResponse)
+
+      estimate = @client.Estimate.create({:number => "EST-0001"})
+
+      assert_instance_of(Invoiced::Estimate, estimate)
+      assert_equal(123, estimate.id)
+      assert_equal('EST-0001', estimate.number)
+    end
+
+    should "retrieve an estimate" do
+      mockResponse = mock('RestClient::Response')
+      mockResponse.stubs(:code).returns(200)
+      mockResponse.stubs(:body).returns('{"id":123,"number":"EST-0001"}')
+      mockResponse.stubs(:headers).returns({})
+
+      RestClient::Request.any_instance.expects(:execute).returns(mockResponse)
+
+      estimate = @client.Estimate.retrieve(123)
+
+      assert_instance_of(Invoiced::Estimate, estimate)
+      assert_equal(123, estimate.id)
+      assert_equal('EST-0001', estimate.number)
+    end
+
+    should "not update an estimate when no params" do
+      estimate = Estimate.new(@client, 123)
+      assert_false(estimate.save)
+    end
+
+    should "update an estimate" do
+      mockResponse = mock('RestClient::Response')
+      mockResponse.stubs(:code).returns(200)
+      mockResponse.stubs(:body).returns('{"id":123,"closed":true}')
+      mockResponse.stubs(:headers).returns({})
+
+      RestClient::Request.any_instance.expects(:execute).returns(mockResponse)
+
+      estimate = Estimate.new(@client, 123)
+      estimate.closed = true
+      assert_true(estimate.save)
+
+      assert_true(estimate.closed)
+    end
+
+    should "list all estimates" do
+      mockResponse = mock('RestClient::Response')
+      mockResponse.stubs(:code).returns(200)
+      mockResponse.stubs(:body).returns('[{"id":123,"number":"EST-0001"}]')
+      mockResponse.stubs(:headers).returns(:x_total_count => 15, :link => '<https://api.invoiced.com/estimates?per_page=25&page=1>; rel="self", <https://api.invoiced.com/estimates?per_page=25&page=1>; rel="first", <https://api.invoiced.com/estimates?per_page=25&page=1>; rel="last"')
+
+      RestClient::Request.any_instance.expects(:execute).returns(mockResponse)
+
+      estimates, metadata = @client.Estimate.list
+
+      assert_instance_of(Array, estimates)
+      assert_equal(1, estimates.length)
+      assert_equal(123, estimates[0].id)
+
+      assert_instance_of(Invoiced::List, metadata)
+      assert_equal(15, metadata.total_count)
+    end
+
+    should "delete an estimate" 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)
+
+      estimate = Estimate.new(@client, 123)
+      assert_true(estimate.delete)
+    end
+
+    should "send an estimate" do
+      mockResponse = mock('RestClient::Response')
+      mockResponse.stubs(:code).returns(201)
+      mockResponse.stubs(:body).returns('[{"id":4567,"email":"test@example.com"}]')
+      mockResponse.stubs(:headers).returns({})
+
+      RestClient::Request.any_instance.expects(:execute).returns(mockResponse)
+
+      estimate = Estimate.new(@client, 1234)
+      emails = estimate.send
+
+      assert_instance_of(Array, emails)
+      assert_equal(1, emails.length)
+      assert_instance_of(Invoiced::Email, emails[0])
+      assert_equal(4567, emails[0].id)
+    end
+
+    should "list all of the estimate's attachments" do
+      mockResponse = mock('RestClient::Response')
+      mockResponse.stubs(:code).returns(200)
+      mockResponse.stubs(:body).returns('[{"file":{"id":456}}]')
+      mockResponse.stubs(:headers).returns(:x_total_count => 10, :link => '<https://api.invoiced.com/estimates/123/attachments?per_page=25&page=1>; rel="self", <https://api.invoiced.com/estimates/123/attachments?per_page=25&page=1>; rel="first", <https://api.invoiced.com/estimates/123/attachments?per_page=25&page=1>; rel="last"')
+
+      RestClient::Request.any_instance.expects(:execute).returns(mockResponse)
+
+      estimate = Estimate.new(@client, 123)
+      attachments, metadata = estimate.attachments
+
+      assert_instance_of(Array, attachments)
+      assert_equal(1, attachments.length)
+      assert_equal(456, attachments[0].id)
+
+      assert_instance_of(Invoiced::List, metadata)
+      assert_equal(10, metadata.total_count)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: invoiced
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Jared King
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-12 00:00:00.000000000 Z
+date: 2017-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -124,6 +124,7 @@ files:
 - lib/invoiced.rb
 - lib/invoiced/attachment.rb
 - lib/invoiced/contact.rb
+- lib/invoiced/credit_note.rb
 - lib/invoiced/customer.rb
 - lib/invoiced/email.rb
 - lib/invoiced/error/api_connection_error.rb
@@ -131,6 +132,7 @@ files:
 - lib/invoiced/error/authentication_error.rb
 - lib/invoiced/error/error_base.rb
 - lib/invoiced/error/invalid_request.rb
+- lib/invoiced/estimate.rb
 - lib/invoiced/event.rb
 - lib/invoiced/file.rb
 - lib/invoiced/invoice.rb
@@ -146,8 +148,10 @@ files:
 - lib/invoiced/util.rb
 - lib/invoiced/version.rb
 - test/invoiced/contact_test.rb
+- test/invoiced/credit_note_test.rb
 - test/invoiced/customer_test.rb
 - test/invoiced/error_test.rb
+- test/invoiced/estimate_test.rb
 - test/invoiced/event_test.rb
 - test/invoiced/file_test.rb
 - test/invoiced/invoice_test.rb
@@ -184,8 +188,10 @@ specification_version: 4
 summary: Ruby client library for the Invoiced API
 test_files:
 - test/invoiced/contact_test.rb
+- test/invoiced/credit_note_test.rb
 - test/invoiced/customer_test.rb
 - test/invoiced/error_test.rb
+- test/invoiced/estimate_test.rb
 - test/invoiced/event_test.rb
 - test/invoiced/file_test.rb
 - test/invoiced/invoice_test.rb