invoiced 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7d993a9653fa91682598ce436fd439aac622038b
-  data.tar.gz: 37fe418a43489d5455477001bd89d11a72a627fb
+  metadata.gz: 110fedfb4c7cae791aba433214d0f8d5ce08c322
+  data.tar.gz: fc4acd0b415091216c3d83291cbea330cc5f7619
 SHA512:
-  metadata.gz: d49663b88444545d104013081d64d7ef34b3a6e7ba631aa5ae33aa7562ebd545266af5d9fe46f0b56b98ddb1d8c8e89be048a80ae06bc0193d1bb89a5f26ac2a
-  data.tar.gz: a2b40dda8276ca3baeb4f2b0165249980d64fe92f0be2d9d8894738881409c22cae3f5e521b1be8e3ce079a9f7d40fa870e4c53075ad19303be856a92134b4c4
+  metadata.gz: ec0bb6d4d38e029afd787bd7e115d27e1c486d1fa13ae4af5f8ee0ff8e87e96fbc9b58bae272decb58c27a9638b88015513ae0a832137be7be3b791fac625a9d
+  data.tar.gz: d6ad87477c2c50e44a9df3b7ae3417729d8da78832b97e6d20815d98b9583bacadda9e7cbd694994cbe569762290711c537ac6d7e9f09797989d852e5d0682af

data/README.md

@@ -24,7 +24,7 @@ gem 'invoiced'
 
 ## Requirements
 
-- >= Ruby 1.9.3
+- Ruby 1.9.3+
 - rest_client, json, and active_support gems
 
 ## Usage

data/lib/invoiced/catalog_item.rb

@@ -0,0 +1,8 @@
+module Invoiced
+    class CatalogItem < Object
+        include Invoiced::Operations::List
+        include Invoiced::Operations::Create
+        include Invoiced::Operations::Update
+        include Invoiced::Operations::Delete
+    end
+end

data/lib/invoiced/operations/update.rb

@@ -8,7 +8,7 @@ module Invoiced
                     update[k] = @values[k]
                 end
 
-                update.merge(params)
+                update = update.merge(params)
 
                 # perform the update if there are any changes
                 if update.length > 0
@@ -24,4 +24,4 @@ module Invoiced
             end
         end
     end
-end
+end

data/lib/invoiced/payment_plan.rb

@@ -1,6 +1,5 @@
 module Invoiced
     class PaymentPlan < Object
-        include Invoiced::Operations::List
         include Invoiced::Operations::Delete
 
         def initialize(client, id=nil, values={})

data/lib/invoiced/plan.rb

@@ -0,0 +1,8 @@
+module Invoiced
+    class Plan < Object
+        include Invoiced::Operations::List
+        include Invoiced::Operations::Create
+        include Invoiced::Operations::Update
+        include Invoiced::Operations::Delete
+    end
+end

data/lib/invoiced/version.rb

@@ -1,3 +1,3 @@
 module Invoiced
-  VERSION = '0.9.0'
+  VERSION = '0.10.0'
 end

data/lib/invoiced.rb

@@ -18,6 +18,7 @@ require 'invoiced/operations/update'
 
 require 'invoiced/object'
 require 'invoiced/attachment'
+require 'invoiced/catalog_item'
 require 'invoiced/contact'
 require 'invoiced/credit_note'
 require 'invoiced/customer'
@@ -28,6 +29,7 @@ require 'invoiced/file'
 require 'invoiced/invoice'
 require 'invoiced/line_item'
 require 'invoiced/payment_plan'
+require 'invoiced/plan'
 require 'invoiced/subscription'
 require 'invoiced/transaction'
 
@@ -37,7 +39,7 @@ module Invoiced
         ApiBaseSandbox = 'https://api.sandbox.invoiced.com'
 
         attr_reader :api_key, :api_url, :sandbox
-        attr_reader :CreditNote, :Customer, :Estimate, :Event, :File, :Invoice, :Subscription, :Transaction
+        attr_reader :CatalogItem, :CreditNote, :Customer, :Estimate, :Event, :File, :Invoice, :Plan, :Subscription, :Transaction
 
         def initialize(api_key, sandbox=false)
           @api_key = api_key
@@ -45,12 +47,14 @@ module Invoiced
           @api_url = sandbox ? ApiBaseSandbox : ApiBase
 
           # Object endpoints
+          @CatalogItem = Invoiced::CatalogItem.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)
+          @Plan = Invoiced::Plan.new(self)
           @Subscription = Invoiced::Subscription.new(self)
           @Transaction = Invoiced::Transaction.new(self)
         end

data/test/invoiced/catalog_item_test.rb

@@ -0,0 +1,90 @@
+require File.expand_path('../../test_helper', __FILE__)
+
+module Invoiced
+  class CatalogItemTest < Test::Unit::TestCase
+    should "return the api endpoint" do
+      catalogItem = CatalogItem.new(@client, "test")
+      assert_equal('/catalog_items/test', catalogItem.endpoint())
+    end
+
+    should "create a catalog item" do
+      mockResponse = mock('RestClient::Response')
+      mockResponse.stubs(:code).returns(201)
+      mockResponse.stubs(:body).returns('{"id":"test","name":"Test Item"}')
+      mockResponse.stubs(:headers).returns({})
+
+      RestClient::Request.any_instance.expects(:execute).returns(mockResponse)
+
+      catalogItem = @client.CatalogItem.create({:name => "Test Item"})
+
+      assert_instance_of(Invoiced::CatalogItem, catalogItem)
+      assert_equal("test", catalogItem.id)
+      assert_equal('Test Item', catalogItem.name)
+    end
+
+    should "retrieve a catalog item" do
+      mockResponse = mock('RestClient::Response')
+      mockResponse.stubs(:code).returns(200)
+      mockResponse.stubs(:body).returns('{"id":"test","name":"Test Item"}')
+      mockResponse.stubs(:headers).returns({})
+
+      RestClient::Request.any_instance.expects(:execute).returns(mockResponse)
+
+      catalogItem = @client.CatalogItem.retrieve("test")
+
+      assert_instance_of(Invoiced::CatalogItem, catalogItem)
+      assert_equal("test", catalogItem.id)
+      assert_equal('Test Item', catalogItem.name)
+    end
+
+    should "not update a catalog item when no params" do
+      catalogItem = CatalogItem.new(@client, "test")
+      assert_false(catalogItem.save)
+    end
+
+    should "update a catalog item" do
+      mockResponse = mock('RestClient::Response')
+      mockResponse.stubs(:code).returns(200)
+      mockResponse.stubs(:body).returns('{"id":"test","closed":true}')
+      mockResponse.stubs(:headers).returns({})
+
+      RestClient::Request.any_instance.expects(:execute).returns(mockResponse)
+
+      catalogItem = CatalogItem.new(@client, "test")
+      catalogItem.closed = true
+      assert_true(catalogItem.save)
+
+      assert_true(catalogItem.closed)
+    end
+
+    should "list all catalog items" do
+      mockResponse = mock('RestClient::Response')
+      mockResponse.stubs(:code).returns(200)
+      mockResponse.stubs(:body).returns('[{"id":"test","name":"Test Item"}]')
+      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)
+
+      catalogItems, metadata = @client.CatalogItem.list
+
+      assert_instance_of(Array, catalogItems)
+      assert_equal(1, catalogItems.length)
+      assert_equal("test", catalogItems[0].id)
+
+      assert_instance_of(Invoiced::List, metadata)
+      assert_equal(15, metadata.total_count)
+    end
+
+    should "delete a catalog item" 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)
+
+      catalogItem = CatalogItem.new(@client, "test")
+      assert_true(catalogItem.delete)
+    end
+  end
+end

data/test/invoiced/plan_test.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: invoiced
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Jared King
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-16 00:00:00.000000000 Z
+date: 2017-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -123,6 +123,7 @@ files:
 - invoiced.gemspec
 - lib/invoiced.rb
 - lib/invoiced/attachment.rb
+- lib/invoiced/catalog_item.rb
 - lib/invoiced/contact.rb
 - lib/invoiced/credit_note.rb
 - lib/invoiced/customer.rb
@@ -144,10 +145,12 @@ files:
 - lib/invoiced/operations/list.rb
 - lib/invoiced/operations/update.rb
 - lib/invoiced/payment_plan.rb
+- lib/invoiced/plan.rb
 - lib/invoiced/subscription.rb
 - lib/invoiced/transaction.rb
 - lib/invoiced/util.rb
 - lib/invoiced/version.rb
+- test/invoiced/catalog_item_test.rb
 - test/invoiced/contact_test.rb
 - test/invoiced/credit_note_test.rb
 - test/invoiced/customer_test.rb
@@ -160,6 +163,7 @@ files:
 - test/invoiced/line_item_test.rb
 - test/invoiced/object_test.rb
 - test/invoiced/payment_plan_test.rb
+- test/invoiced/plan_test.rb
 - test/invoiced/subscription_test.rb
 - test/invoiced/transaction_test.rb
 - test/invoiced/util_test.rb
@@ -189,6 +193,7 @@ signing_key:
 specification_version: 4
 summary: Ruby client library for the Invoiced API
 test_files:
+- test/invoiced/catalog_item_test.rb
 - test/invoiced/contact_test.rb
 - test/invoiced/credit_note_test.rb
 - test/invoiced/customer_test.rb
@@ -201,6 +206,7 @@ test_files:
 - test/invoiced/line_item_test.rb
 - test/invoiced/object_test.rb
 - test/invoiced/payment_plan_test.rb
+- test/invoiced/plan_test.rb
 - test/invoiced/subscription_test.rb
 - test/invoiced/transaction_test.rb
 - test/invoiced/util_test.rb