curdbee 0.0.1

data/lib/curdbee/error.rb

@@ -0,0 +1,23 @@
+module CurdBee
+  module Error
+
+    class Base < StandardError
+      attr_reader :response
+
+      def initialize(response=nil)
+        @response  = response
+      end
+    end
+
+    class AccessDenied        < Base; end # 401 errors
+    class Forbidden           < Base; end # 403 errors
+    class BadRequest          < Base; end # 422 errors
+    class NotFound            < Base; end # 404 errors
+    class ServerError         < Base; end # 500 errors
+    class ConnectionFailed    < Base; end
+    
+    class UnexpectedResponse  < Base; end
+
+  end
+end
+

data/lib/curdbee/estimate.rb

@@ -0,0 +1,14 @@
+module CurdBee
+ class Estimate < Base
+   @resource = "estimates"
+   @element = "estimate"
+
+   include CurdBee::Invoiceable
+
+   def convert
+     response = self.class.send_request(:post, "/#{self.class.resource}/#{self[:id]}/convert")
+     self.class.new(response["invoice"])
+   end
+
+ end
+end

data/lib/curdbee/invoice.rb

@@ -0,0 +1,10 @@
+module CurdBee
+ class Invoice < Base
+
+   @resource = "invoices"
+   @element = "invoice"
+
+   include CurdBee::Invoiceable
+
+ end
+end

data/lib/curdbee/invoiceable.rb

@@ -0,0 +1,35 @@
+module CurdBee
+  module Invoiceable
+
+    # common methods for invoices and estimates
+
+    def duplicate
+     response = self.class.send_request(:post, "/#{self.class.resource}/#{self[:id]}/duplicate")
+     self.class.new(response["#{self.class.element}"])
+    end
+
+    def close
+     response = self.class.send_request(:post, "/#{self.class.resource}/#{self[:id]}/close")
+     return true if response.code.to_i == 200
+    end
+
+    def reopen
+     response = self.class.send_request(:post, "/#{self.class.resource}/#{self[:id]}/reopen")
+     return true if response.code.to_i == 200
+    end
+
+    def deliver 
+     response = self.class.send_request(:post, "/deliver/#{self.class.element}/#{self[:id]}")
+     return true if response.code.to_i == 200
+    end
+
+    def permalink
+     statement_type = self.class.element == "estimate" ? "est" : "inv"
+     unless self.hash_key.nil? || self.hash_key.empty?
+       "#{self.class.base_uri}/#{statement_type}/#{self.hash_key}" 
+     else
+       ""
+     end
+    end
+ end
+end

data/lib/curdbee/item.rb

@@ -0,0 +1,6 @@
+module CurdBee
+ class Item < Base
+   @resource = "items"
+   @element = "item"
+ end
+end

data/lib/curdbee/parser.rb

@@ -0,0 +1,13 @@
+module CurdBee
+  class Parser < HTTParty::Parser
+
+    def parse
+      begin
+        Crack::JSON.parse(body)
+      rescue => e
+        raise(CurdBee::Error::UnexpectedResponse.new(e.message), body)
+      end
+    end
+
+  end
+end

data/lib/curdbee/payment.rb

@@ -0,0 +1,18 @@
+module CurdBee
+ class Payment < Base
+
+   class << self; 
+     def invoice_id=(value)
+       @invoice_id = value
+       self.resource = "invoices/#{@invoice_id}/payments"
+      end
+
+      def invoice_id
+        @invoice_id
+      end
+   end
+ 
+   @element = "payment"
+
+ end
+end

data/lib/curdbee/recurring_profile.rb

@@ -0,0 +1,6 @@
+module CurdBee
+ class RecurringProfile < Base
+   @resource = "recurring_profiles"
+   @element = "recurring_profile"
+ end
+end

data/spec/client_spec.rb

@@ -0,0 +1,144 @@
+require 'spec_helper'
+
+describe CurdBee::Client do
+
+  describe 'list' do
+
+    before do
+      CurdBee::Config.api_key = "TYMuwW6rM2PQnoWx1ht4"
+      CurdBee::Config.subdomain = "test"
+    end
+
+    it "should return a list of clients" do
+      stub_get "http://test.curdbee.com/clients.json?api_token=TYMuwW6rM2PQnoWx1ht4&page=1&per_page=20", "clients.json"
+      result = CurdBee::Client.list
+      result.first.name.should == "Awesome Inc." 
+    end
+
+    it "should take limit as an option" do
+      stub_get "http://test.curdbee.com/clients.json?api_token=TYMuwW6rM2PQnoWx1ht4&page=1&per_page=1", "clients.json"
+      result = CurdBee::Client.list(:limit => 1)
+      result.length.should == 1 
+    end
+
+    it "should take page as an option" do
+      stub_get "http://test.curdbee.com/clients.json?api_token=TYMuwW6rM2PQnoWx1ht4&page=2&per_page=1", "clients.json"
+      result = CurdBee::Client.list(:limit => 1, :page => 2)
+      result.length.should == 1 
+    end
+  end
+
+  describe 'show' do
+
+    before do
+      CurdBee::Config.api_key = "TYMuwW6rM2PQnoWx1ht4"
+      CurdBee::Config.subdomain = "test"
+      #@client = CurdBee::Client.new
+    end
+   
+    it "should return the matching client" do
+      stub_get "http://test.curdbee.com/clients/31.json?api_token=TYMuwW6rM2PQnoWx1ht4", "client.json"
+      result = CurdBee::Client.show(31)
+      result.name.should == "Awesome Inc." 
+    end
+
+    it "should raise an error if nothing found" do
+      stub_get "http://test.curdbee.com/clients/32.json?api_token=TYMuwW6rM2PQnoWx1ht4", "", 404
+      lambda{
+        CurdBee::Client.show(32)
+      }.should raise_error(CurdBee::Error::NotFound)
+    end
+
+  end
+
+  describe 'create' do
+
+    before do
+      CurdBee::Config.api_key = "TYMuwW6rM2PQnoWx1ht4"
+      CurdBee::Config.subdomain = "test"
+    end
+   
+    it "should return the created client" do
+      stub_post "http://test.curdbee.com/clients?api_token=TYMuwW6rM2PQnoWx1ht4", "new_client.json"
+      @client = CurdBee::Client.new(
+                                      :name => "RickRoll Inc.",
+                                      :email => "rickroll@example.com",
+                                      :currency_id => 150
+                                   )
+      result = @client.create
+      @client.id.should == 34 
+    end
+
+    it "should raise an error if creation fails" do
+      stub_post "http://test.curdbee.com/clients?api_token=TYMuwW6rM2PQnoWx1ht4", "", 422
+      lambda{
+        @client = CurdBee::Client.new()
+        @client.create
+      }.should raise_error(CurdBee::Error::BadRequest)
+    end
+
+
+  end
+
+  describe 'update' do
+
+    before do
+      CurdBee::Config.api_key = "TYMuwW6rM2PQnoWx1ht4"
+      CurdBee::Config.subdomain = "test"
+      stub_get "http://test.curdbee.com/clients/31.json?api_token=TYMuwW6rM2PQnoWx1ht4", "client.json"
+      @client = CurdBee::Client.show(31)
+    end
+   
+    it "should return the updated client" do
+      stub_put "http://test.curdbee.com/clients/31?api_token=TYMuwW6rM2PQnoWx1ht4", "new_client.json"
+      @client.name = "RickRoll Inc."
+      @client.email = "rickroll@example.com"
+
+      result = @client.update
+      result.should be_true
+    end
+
+    it "should raise an error if update fails" do
+      stub_put "http://test.curdbee.com/clients/31?api_token=TYMuwW6rM2PQnoWx1ht4", "", 422
+      lambda{
+        @client.name = ""
+        @client.update
+      }.should raise_error(CurdBee::Error::BadRequest)
+    end
+
+
+  end
+
+  describe 'delete' do
+
+    before do
+      CurdBee::Config.api_key = "TYMuwW6rM2PQnoWx1ht4"
+      CurdBee::Config.subdomain = "test"
+      stub_get "http://test.curdbee.com/clients/31.json?api_token=TYMuwW6rM2PQnoWx1ht4", "client.json"
+      @client = CurdBee::Client.show(31)
+    end
+   
+    it "should return true if client was deleted" do
+      stub_delete "http://test.curdbee.com/clients/31?api_token=TYMuwW6rM2PQnoWx1ht4", "", 200
+      result = @client.delete
+      result.should == true 
+    end
+
+    it "should raise a bad request error if deletion fails" do
+      stub_delete "http://test.curdbee.com/clients/31?api_token=TYMuwW6rM2PQnoWx1ht4", "", 422
+      lambda{
+        @client.delete
+      }.should raise_error(CurdBee::Error::BadRequest)
+    end
+
+    it "should raise a not found error if client doesnt exist" do
+      stub_delete "http://test.curdbee.com/clients/31?api_token=TYMuwW6rM2PQnoWx1ht4", "", 404
+      lambda{
+        @client.delete
+      }.should raise_error(CurdBee::Error::NotFound)
+    end
+
+
+  end
+
+end

data/spec/estimate_spec.rb

@@ -0,0 +1,312 @@
+require 'spec_helper'
+
+describe CurdBee::Estimate do
+
+  describe 'list' do
+
+    before do
+      CurdBee::Config.api_key = "TYMuwW6rM2PQnoWx1ht4"
+      CurdBee::Config.subdomain = "test"
+    end
+
+    it "should return a list of estimates" do
+      stub_get "http://test.curdbee.com/estimates.json?api_token=TYMuwW6rM2PQnoWx1ht4&page=1&per_page=20", "estimates.json"
+      result = CurdBee::Estimate.list
+      result.first.estimate_no.should == "TEST-1" 
+    end
+
+    it "should take limit as an option" do
+      stub_get "http://test.curdbee.com/estimates.json?api_token=TYMuwW6rM2PQnoWx1ht4&page=1&per_page=1", "estimates.json"
+      result = CurdBee::Estimate.list(:limit => 1)
+      result.length.should == 1 
+    end
+
+    it "should take page as an option" do
+      stub_get "http://test.curdbee.com/estimates.json?api_token=TYMuwW6rM2PQnoWx1ht4&page=2&per_page=1", "estimates.json"
+      result = CurdBee::Estimate.list(:limit => 1, :page => 2)
+      result.length.should == 1 
+    end
+  end
+
+  describe 'show' do
+
+    before do
+      CurdBee::Config.api_key = "TYMuwW6rM2PQnoWx1ht4"
+      CurdBee::Config.subdomain = "test"
+    end
+   
+    it "should return the matching estimate" do
+      stub_get "http://test.curdbee.com/estimates/31.json?api_token=TYMuwW6rM2PQnoWx1ht4", "estimate.json"
+      result = CurdBee::Estimate.show(31)
+      result.estimate_no.should == "TEST-1" 
+    end
+
+    it "should raise an error if nothing found" do
+      stub_get "http://test.curdbee.com/estimates/32.json?api_token=TYMuwW6rM2PQnoWx1ht4", "", 404
+      lambda{
+        CurdBee::Estimate.show(32)
+      }.should raise_error(CurdBee::Error::NotFound)
+    end
+
+  end
+
+  describe 'create' do
+
+    before do
+      CurdBee::Config.api_key = "TYMuwW6rM2PQnoWx1ht4"
+      CurdBee::Config.subdomain = "test"
+    end
+   
+    it "should return the created estimate" do
+      stub_post "http://test.curdbee.com/estimates?api_token=TYMuwW6rM2PQnoWx1ht4", "new_estimate.json"
+      estimate_info = {:date => Date.today, :estimate_no => "EST-NEW", :client_id => @client.id,
+                      :line_items_attributes => [{:name_and_description => "Sample Item", :quantity => 1, :price => 25.00, :unit => "hour"}]
+                     }
+      @estimate = CurdBee::Estimate.new(estimate_info)
+      result = @estimate.create
+      @estimate.id.should == 31 
+    end
+
+    it "should raise an error if creation fails" do
+      stub_post "http://test.curdbee.com/estimates?api_token=TYMuwW6rM2PQnoWx1ht4", "", 422
+      lambda{
+        @estimate = CurdBee::Estimate.new({})
+        @estimate.create
+      }.should raise_error(CurdBee::Error::BadRequest)
+    end
+
+
+  end
+
+  describe 'update' do
+
+    before do
+      CurdBee::Config.api_key = "TYMuwW6rM2PQnoWx1ht4"
+      CurdBee::Config.subdomain = "test"
+      stub_get "http://test.curdbee.com/estimates/31.json?api_token=TYMuwW6rM2PQnoWx1ht4", "estimate.json"
+      @estimate = CurdBee::Estimate.show(31)
+    end
+   
+    it "should return the updated estimate" do
+      stub_put "http://test.curdbee.com/estimates/31?api_token=TYMuwW6rM2PQnoWx1ht4", "new_estimate.json"
+      @estimate.estimate_no = "EST-NEW"
+      @estimate.date = Date.today
+
+      result = @estimate.update
+      result.should be_true 
+    end
+
+    it "should raise an error if update fails" do
+      stub_put "http://test.curdbee.com/estimates/31?api_token=TYMuwW6rM2PQnoWx1ht4", "", 422
+      lambda{
+        @estimate.estimate_no = ""
+        @estimate.update
+      }.should raise_error(CurdBee::Error::BadRequest)
+    end
+
+
+  end
+
+  describe 'delete' do
+
+    before do
+      CurdBee::Config.api_key = "TYMuwW6rM2PQnoWx1ht4"
+      CurdBee::Config.subdomain = "test"
+      stub_get "http://test.curdbee.com/estimates/31.json?api_token=TYMuwW6rM2PQnoWx1ht4", "estimate.json"
+      @estimate = CurdBee::Estimate.show(31)
+    end
+   
+    it "should return true if estimate was deleted" do
+      stub_delete "http://test.curdbee.com/estimates/31?api_token=TYMuwW6rM2PQnoWx1ht4", "", 200
+      result = @estimate.delete
+      result.should be_true 
+    end
+
+    it "should raise a bad request error if deletion fails" do
+      stub_delete "http://test.curdbee.com/estimates/31?api_token=TYMuwW6rM2PQnoWx1ht4", "", 422
+      lambda{
+        @estimate.delete
+      }.should raise_error(CurdBee::Error::BadRequest)
+    end
+
+    it "should raise a not found error if estimate doesnt exist" do
+      stub_delete "http://test.curdbee.com/estimates/31?api_token=TYMuwW6rM2PQnoWx1ht4", "", 404
+      lambda{
+        @estimate.delete
+      }.should raise_error(CurdBee::Error::NotFound)
+    end
+
+
+  end
+
+  describe 'duplicate' do
+
+    before do
+      CurdBee::Config.api_key = "TYMuwW6rM2PQnoWx1ht4"
+      CurdBee::Config.subdomain = "test"
+      stub_get "http://test.curdbee.com/estimates/31.json?api_token=TYMuwW6rM2PQnoWx1ht4", "estimate.json"
+      @estimate = CurdBee::Estimate.show(31)
+    end
+   
+    it "should return the duplicated estimate if it was duplicated" do
+      stub_post "http://test.curdbee.com/estimates/31/duplicate?api_token=TYMuwW6rM2PQnoWx1ht4", "new_estimate.json"
+      result = @estimate.duplicate
+      result.estimate_no.should == "EST-NEW" 
+    end
+
+    it "should raise a bad request error if duplication fails" do
+      stub_post "http://test.curdbee.com/estimates/31/duplicate?api_token=TYMuwW6rM2PQnoWx1ht4", "", 422
+      lambda{
+        @estimate.duplicate
+      }.should raise_error(CurdBee::Error::BadRequest)
+    end
+
+    it "should raise a not found error if estimate doesnt exist" do
+      stub_post "http://test.curdbee.com/estimates/31/duplicate?api_token=TYMuwW6rM2PQnoWx1ht4", "", 404
+      lambda{
+        @estimate.duplicate
+      }.should raise_error(CurdBee::Error::NotFound)
+    end
+  end
+
+  describe 'close' do
+
+    before do
+      CurdBee::Config.api_key = "TYMuwW6rM2PQnoWx1ht4"
+      CurdBee::Config.subdomain = "test"
+      stub_get "http://test.curdbee.com/estimates/31.json?api_token=TYMuwW6rM2PQnoWx1ht4", "estimate.json"
+      @estimate = CurdBee::Estimate.show(31)
+    end
+   
+    it "should return true if estimate was closed" do
+      stub_post "http://test.curdbee.com/estimates/31/close?api_token=TYMuwW6rM2PQnoWx1ht4", "", 200
+      result = @estimate.close
+      result.should be_true 
+    end
+
+    it "should raise a bad request error if closing fails" do
+      stub_post "http://test.curdbee.com/estimates/31/close?api_token=TYMuwW6rM2PQnoWx1ht4", "", 422
+      lambda{
+        @estimate.close
+      }.should raise_error(CurdBee::Error::BadRequest)
+    end
+
+    it "should raise a not found error if estimate doesnt exist" do
+      stub_post "http://test.curdbee.com/estimates/31/close?api_token=TYMuwW6rM2PQnoWx1ht4", "", 404
+      lambda{
+        @estimate.close
+      }.should raise_error(CurdBee::Error::NotFound)
+    end
+  end
+
+  describe 'reopen' do
+
+    before do
+      CurdBee::Config.api_key = "TYMuwW6rM2PQnoWx1ht4"
+      CurdBee::Config.subdomain = "test"
+      stub_get "http://test.curdbee.com/estimates/31.json?api_token=TYMuwW6rM2PQnoWx1ht4", "estimate.json"
+      @estimate = CurdBee::Estimate.show(31)
+    end
+   
+    it "should return true if estimate was reopened" do
+      stub_post "http://test.curdbee.com/estimates/31/reopen?api_token=TYMuwW6rM2PQnoWx1ht4", "", 200
+      result = @estimate.reopen
+      result.should be_true 
+    end
+
+    it "should raise a bad request error if reopening fails" do
+      stub_post "http://test.curdbee.com/estimates/31/reopen?api_token=TYMuwW6rM2PQnoWx1ht4", "", 422
+      lambda{
+        @estimate.reopen
+      }.should raise_error(CurdBee::Error::BadRequest)
+    end
+
+    it "should raise a not found error if estimate doesnt exist" do
+      stub_post "http://test.curdbee.com/estimates/31/reopen?api_token=TYMuwW6rM2PQnoWx1ht4", "", 404
+      lambda{
+        @estimate.reopen
+      }.should raise_error(CurdBee::Error::NotFound)
+    end
+  end
+
+  describe 'convert' do
+
+    before do
+      CurdBee::Config.api_key = "TYMuwW6rM2PQnoWx1ht4"
+      CurdBee::Config.subdomain = "test"
+      stub_get "http://test.curdbee.com/estimates/31.json?api_token=TYMuwW6rM2PQnoWx1ht4", "estimate.json"
+      @estimate = CurdBee::Estimate.show(31)
+    end
+   
+    it "should return the invoice if estimate was converted to a invoice" do
+      stub_post "http://test.curdbee.com/estimates/31/convert?api_token=TYMuwW6rM2PQnoWx1ht4", "new_invoice.json"
+      result = @estimate.convert
+      result.invoice_no.should == "IN-NEW" 
+    end
+
+    it "should raise a bad request error if reopening fails" do
+      stub_post "http://test.curdbee.com/estimates/31/convert?api_token=TYMuwW6rM2PQnoWx1ht4", "", 422
+      lambda{
+        @estimate.convert
+      }.should raise_error(CurdBee::Error::BadRequest)
+    end
+
+    it "should raise a not found error if estimate doesnt exist" do
+      stub_post "http://test.curdbee.com/estimates/31/convert?api_token=TYMuwW6rM2PQnoWx1ht4", "", 404
+      lambda{
+        @estimate.convert
+      }.should raise_error(CurdBee::Error::NotFound)
+    end
+
+  end
+
+  describe 'deliver' do
+
+    before do
+      CurdBee::Config.api_key = "TYMuwW6rM2PQnoWx1ht4"
+      CurdBee::Config.subdomain = "test"
+      stub_get "http://test.curdbee.com/estimates/31.json?api_token=TYMuwW6rM2PQnoWx1ht4", "estimate.json"
+      @estimate = CurdBee::Estimate.show(31)
+    end
+   
+    it "should return true if estimate was sent" do
+      stub_post "http://test.curdbee.com/deliver/estimate/31?api_token=TYMuwW6rM2PQnoWx1ht4", "", 200
+      result = @estimate.deliver
+      result.should be_true 
+    end
+
+    it "should raise a bad request error if sending fails" do
+      stub_post "http://test.curdbee.com/deliver/estimate/31?api_token=TYMuwW6rM2PQnoWx1ht4", "", 422
+      lambda{
+        @estimate.deliver
+      }.should raise_error(CurdBee::Error::BadRequest)
+    end
+
+    it "should raise a not found error if estimate doesnt exist" do
+      stub_post "http://test.curdbee.com/deliver/estimate/31?api_token=TYMuwW6rM2PQnoWx1ht4", "", 404
+      lambda{
+        @estimate.deliver
+      }.should raise_error(CurdBee::Error::NotFound)
+    end
+  end
+
+  describe 'permalink' do
+
+    before do
+      CurdBee::Config.api_key = "TYMuwW6rM2PQnoWx1ht4"
+      CurdBee::Config.subdomain = "test"
+      stub_get "http://test.curdbee.com/estimates/31.json?api_token=TYMuwW6rM2PQnoWx1ht4", "estimate.json"
+      @estimate = CurdBee::Estimate.show(31)
+    end
+   
+    it "should return the permalink to view a sent invoice" do
+      @estimate.permalink.should == "http://test.curdbee.com/est/tx9045ff"
+    end
+
+    it "should return nothing for draft invoices" do
+      @new_estimate = CurdBee::Estimate.new()
+      @new_estimate.permalink.should == ""
+    end
+  end
+
+end