invoiced 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fdb8e10bfea7bc299ee7b9d51d8c85ed70f80049
-  data.tar.gz: 692c072e06fd655d9107068bb59f10a9891b126c
+  metadata.gz: e536c65fccac56b2d988c5fe3aaecbc5c4c68ef4
+  data.tar.gz: d88a8e2e379d5b83b3d422dfefbd90125df90876
 SHA512:
-  metadata.gz: b91243bed87f00e30b922f6204f2216b859f5caed60008e54911db1b321c1b8f06de0076ee8b6f72afd3dbf45718fb2042658d481fdc98d71c459cfbd2be534c
-  data.tar.gz: d175b2b4cf3e21564510a2d18840a1e05f0f04d09c759113712754dae968691e7482f9a33895d96dab12866108024e35d224a09efa12aa3be32f1f7871702ecc
+  metadata.gz: 1432a26201de6db700fc04eecdd012f10e75357bb19111c980f7044ffdb5ed5b0001c27d8b96f2ed9e922a7399e3316892468daf47b5ee6abae7621347ebe7c5
+  data.tar.gz: f0c8fe2b96eb1bd0c470a42bbe12ec736c6afa219511d4d19a1f768ab0ba848392c0ab31729670ac4884a81e43861f7f1c231615bb018acfa4fcd680e9033873

data/invoiced.gemspec

@@ -9,9 +9,9 @@ Gem::Specification.new do |s|
   s.summary     = "Ruby client library for the Invoiced API"
   s.description = "Invoiced makes invoicing and recurring billing dead simple"
   s.authors     = ["Jared King"]
-  s.email       = 'api@invoiced.com'
+  s.email       = 'support@invoiced.com'
   s.files       = ["lib/invoiced.rb"]
-  s.homepage    = 'https://developers.invoiced.com'
+  s.homepage    = 'https://invoiced.com/docs/dev'
   s.required_ruby_version = '>= 1.9.3'
 
   s.add_dependency('rest-client', '~> 1.8.0')

data/lib/invoiced/attachment.rb

@@ -0,0 +1,4 @@
+module Invoiced
+    class Attachment < Object
+	end
+end

data/lib/invoiced/file.rb

@@ -0,0 +1,6 @@
+module Invoiced
+    class File < Object
+		include Invoiced::Operations::Create
+		include Invoiced::Operations::Delete
+	end
+end

data/lib/invoiced/invoice.rb

@@ -21,5 +21,26 @@ module Invoiced
 
 			return response[:code] == 200
 		end
+
+		def attachments(opts={})
+			response = @client.request(:get, "#{self.endpoint()}/attachments", opts)
+
+			# ensure each attachment has an ID
+			body = response[:body]
+			body.each do |attachment|
+				if !attachment.has_key?(:id)
+					attachment[:id] = attachment[:file][:id]
+				end
+			end
+
+			# build objects
+			attachment = Attachment.new(@client)
+			attachments = Util.build_objects(attachment, body)
+
+			# store the metadata from the list operation
+			metadata = Invoiced::List.new(response[:headers][:link], response[:headers][:x_total_count])
+
+			return attachments, metadata
+		end
 	end
 end

data/lib/invoiced/version.rb

@@ -1,3 +1,3 @@
 module Invoiced
-  VERSION = '0.4.0'
+  VERSION = '0.5.0'
 end

data/lib/invoiced.rb

@@ -17,9 +17,11 @@ require 'invoiced/operations/delete'
 require 'invoiced/operations/update'
 
 require 'invoiced/object'
+require 'invoiced/attachment'
 require 'invoiced/contact'
 require 'invoiced/customer'
 require 'invoiced/email'
+require 'invoiced/file'
 require 'invoiced/invoice'
 require 'invoiced/line_item'
 require 'invoiced/transaction'
@@ -31,13 +33,16 @@ module Invoiced
 		ApiBaseSandbox = 'https://api.sandbox.invoiced.com'
 
 		attr_reader :api_key, :api_url, :sandbox
-		attr_reader :Customer, :Invoice, :Transaction, :Subscription
+		attr_reader :Customer, :File, :Invoice, :Transaction, :Subscription
 
 	    def initialize(api_key, sandbox=false)
 	      @api_key = api_key
 	      @sandbox = sandbox
 	      @api_url = sandbox ? ApiBaseSandbox : ApiBase
+
+	      # Object endpoints
 	      @Customer = Invoiced::Customer.new(self)
+	      @File = Invoiced::File.new(self)
 	      @Invoice = Invoiced::Invoice.new(self)
 	      @Transaction = Invoiced::Transaction.new(self)
 	      @Subscription = Invoiced::Subscription.new(self)

data/test/invoiced/file_test.rb

@@ -0,0 +1,54 @@
+require File.expand_path('../../test_helper', __FILE__)
+
+module Invoiced
+  class FileTest < Test::Unit::TestCase
+    should "return the api endpoint" do
+      file = File.new(@client, 123)
+      assert_equal('/files/123', file.endpoint())
+    end
+
+    should "create a file" do
+      mockResponse = mock('RestClient::Response')
+      mockResponse.stubs(:code).returns(201)
+      mockResponse.stubs(:body).returns('{"id":123,"name":"Filename"}')
+      mockResponse.stubs(:headers).returns({})
+
+      RestClient::Request.any_instance.expects(:execute).returns(mockResponse)
+
+      file = File.new(@client)
+      file = file.create({:name => "Filename"})
+
+      assert_instance_of(Invoiced::File, file)
+      assert_equal(123, file.id)
+      assert_equal("Filename", file.name)
+    end
+
+    should "retrieve a file" do
+      mockResponse = mock('RestClient::Response')
+      mockResponse.stubs(:code).returns(200)
+      mockResponse.stubs(:body).returns('{"id":123,"name":"Filename"}')
+      mockResponse.stubs(:headers).returns({})
+
+      RestClient::Request.any_instance.expects(:execute).returns(mockResponse)
+
+      file = File.new(@client)
+      file = file.retrieve(123)
+
+      assert_instance_of(Invoiced::File, file)
+      assert_equal(123, file.id)
+      assert_equal("Filename", file.name)
+    end
+
+    should "delete a file" 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)
+
+      file = File.new(@client, 123)
+      assert_true(file.delete)
+    end
+  end
+end

data/test/invoiced/invoice_test.rb

@@ -117,5 +117,24 @@ module Invoiced
 
       assert_true(invoice.paid)
     end
+
+    should "list all of the invoice'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/invoices/123/attachments?per_page=25&page=1>; rel="self", <https://api.invoiced.com/invoices/123/attachments?per_page=25&page=1>; rel="first", <https://api.invoiced.com/invoices/123/attachments?per_page=25&page=1>; rel="last"')
+
+      RestClient::Request.any_instance.expects(:execute).returns(mockResponse)
+
+      invoice = Invoice.new(@client, 123)
+      attachments, metadata = invoice.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.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Jared King
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-27 00:00:00.000000000 Z
+date: 2016-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -109,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: Invoiced makes invoicing and recurring billing dead simple
-email: api@invoiced.com
+email: support@invoiced.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -122,6 +122,7 @@ files:
 - Rakefile
 - invoiced.gemspec
 - lib/invoiced.rb
+- lib/invoiced/attachment.rb
 - lib/invoiced/contact.rb
 - lib/invoiced/customer.rb
 - lib/invoiced/email.rb
@@ -130,6 +131,7 @@ files:
 - lib/invoiced/error/authentication_error.rb
 - lib/invoiced/error/error_base.rb
 - lib/invoiced/error/invalid_request.rb
+- lib/invoiced/file.rb
 - lib/invoiced/invoice.rb
 - lib/invoiced/line_item.rb
 - lib/invoiced/list.rb
@@ -145,6 +147,7 @@ files:
 - test/invoiced/contact_test.rb
 - test/invoiced/customer_test.rb
 - test/invoiced/error_test.rb
+- test/invoiced/file_test.rb
 - test/invoiced/invoice_test.rb
 - test/invoiced/invoiced_test.rb
 - test/invoiced/line_item_test.rb
@@ -153,7 +156,7 @@ files:
 - test/invoiced/transaction_test.rb
 - test/invoiced/util_test.rb
 - test/test_helper.rb
-homepage: https://developers.invoiced.com
+homepage: https://invoiced.com/docs/dev
 licenses:
 - MIT
 metadata: {}
@@ -181,6 +184,7 @@ test_files:
 - test/invoiced/contact_test.rb
 - test/invoiced/customer_test.rb
 - test/invoiced/error_test.rb
+- test/invoiced/file_test.rb
 - test/invoiced/invoice_test.rb
 - test/invoiced/invoiced_test.rb
 - test/invoiced/line_item_test.rb