invoicexpress 0.1.8 → 0.1.9

data/README.md

@@ -41,7 +41,7 @@ Run bundle, the project should need:
 * Sim. Invoices - 100%
 * Credit Notes  - 100%
 * Purch. Orders - 100%
- 
+
 ## Documentation
 
 We've included docs for all methods. Refer to the doc folder and client section.
@@ -51,9 +51,9 @@ We've included docs for all methods. Refer to the doc folder and client section.
 If using from inside a rails project use:
 
     require 'invoicexpress'
- 
+
     client = Invoicexpress::Client.new(
-      :screen_name => "yourusername",
+      :account_name => "yourusername",
       :api_key     => "yourapikey"
     )
 

data/lib/invoicexpress/client.rb

@@ -51,6 +51,6 @@ module Invoicexpress
     include Invoicexpress::Client::DebitNotes
     include Invoicexpress::Client::CreditNotes
     include Invoicexpress::Client::SimplifiedInvoices
-    
+
   end
 end

data/lib/invoicexpress/client/invoices.rb

@@ -3,7 +3,7 @@ require 'invoicexpress/models'
 module Invoicexpress
   class Client
     module Invoices
-      
+
       # Returns all your invoices
       #
       # @option options [Integer] page (1) You can ask a specific page of invoices
@@ -106,8 +106,6 @@ module Invoicexpress
       def invoice_email(invoice_id, message, options={})
         email_invoice(invoice_id, message, options)
       end
-
-
     end
   end
 end

data/lib/invoicexpress/configuration.rb

@@ -7,6 +7,7 @@ module Invoicexpress
       :adapter,
       :faraday_config_block,
       :api_endpoint,
+      :account_name,
       :screen_name,
       :proxy,
       :api_key,
@@ -44,6 +45,7 @@ module Invoicexpress
       self.api_endpoint = DEFAULT_API_ENDPOINT
       self.user_agent   = DEFAULT_USER_AGENT
       self.api_key      = nil
+      self.account_name = nil
       self.screen_name  = nil
       self.proxy        = nil
     end

data/lib/invoicexpress/connection.rb

@@ -35,6 +35,5 @@ module Invoicexpress
       connection.headers[:user_agent] = user_agent
       connection
     end
-
   end
 end

data/lib/invoicexpress/error.rb

@@ -38,7 +38,7 @@ module Invoicexpress
     private
 
     def build_error_message
-      return nil  if @response.nil?
+      return nil if @response.nil?
 
       message = if response_body
         if response_body.respond_to?(:errors)
@@ -65,4 +65,7 @@ module Invoicexpress
 
   # Raised when Invoicexpress server goes dark (500 HTTP status code)
   class InternalServerError < Error; end
+
+  # Raised when Invoicexpress server address could not be resolved
+  class BadAddress < Error; end
 end

data/lib/invoicexpress/request.rb

@@ -22,8 +22,8 @@ module Invoicexpress
     end
 
     private
-    
-    # Executes the request, checking if ti was successful
+
+    # Executes the request, checking if it was successful
     #
     # @return [Boolean] True on success, false otherwise
     def boolean_from_response(method, path, options={})
@@ -34,7 +34,7 @@ module Invoicexpress
 
     def request(method, path, options={})
       token = options.delete(:api_key)  || api_key
-      url   = options.delete(:endpoint) || (api_endpoint % screen_name)
+      url   = options.delete(:endpoint) || (api_endpoint % account_domain)
       klass = options.delete(:klass) || raise(ArgumentError, "Need a HappyMapper class to parse")
 
       conn_options = {
@@ -57,7 +57,17 @@ module Invoicexpress
       end
 
       response
+    rescue Faraday::ConnectionFailed => e
+      unless e.message.match(/getaddrinfo/).nil?
+        raise Invoicexpress::BadAddress.new,
+          "Did you forget to set your account_name? Error: #{e.message}"
+      end
+
+      raise e
     end
 
+    def account_domain
+      account_name || screen_name
+    end
   end
 end

data/lib/invoicexpress/version.rb

@@ -1,5 +1,5 @@
 module Invoicexpress
-  Invoicexpress::VERSION = "0.1.8"
+  Invoicexpress::VERSION = "0.1.9"
 
   VERSION  = "0.0.0" unless defined?(Invoicexpress::VERSION)
 end

data/spec/invoicexpress/client/charts_spec.rb

@@ -3,7 +3,7 @@ require 'helper'
 describe Invoicexpress::Client::Charts do
 
   before do
-    @client = Invoicexpress::Client.new(:screen_name => "thinkorangeteste")
+    @client = Invoicexpress::Client.new(:account_name => "thinkorangeteste")
   end
 
   describe ".invoicing_chart" do
@@ -29,10 +29,10 @@ describe Invoicexpress::Client::Charts do
       chart.graphs.count.should ==4
       #count values
       chart.graphs.first.values.count.should ==7
-      
+
     end
   end
-  
+
   describe ".top_clients" do
     it "Returns the top 5 clients." do
        stub_get("/api/charts/top-clients.xml").
@@ -43,7 +43,7 @@ describe Invoicexpress::Client::Charts do
        chart.clients.size.should ==1
     end
   end
-  
+
   describe ".top_debtors" do
     it "Returns the top 5 debtors." do
        stub_get("/api/charts/top-debtors.xml").

data/spec/invoicexpress/client/clients_spec.rb

@@ -3,7 +3,7 @@ require 'helper'
 describe Invoicexpress::Client::Clients do
 
   before do
-    @client = Invoicexpress::Client.new(:screen_name => "thinkorangeteste")
+    @client = Invoicexpress::Client.new(:account_name => "thinkorangeteste")
   end
 
   describe ".clients" do

data/spec/invoicexpress/client/credit_notes_spec.rb

@@ -2,7 +2,7 @@ require 'helper'
 
 describe Invoicexpress::Client::CreditNotes do
   before do
-    @client = Invoicexpress::Client.new(:screen_name => "thinkorangeteste")
+    @client = Invoicexpress::Client.new(:account_name => "thinkorangeteste")
   end
 
   describe ".credit_notes" do
@@ -21,7 +21,7 @@ describe Invoicexpress::Client::CreditNotes do
       stub_post("/credit_notes.xml").
         to_return(xml_response("credit_notes.create.xml"))
 
-      
+
       cnote = Invoicexpress::Models::CreditNote.new(
         :date => Date.new(2013, 5, 1),
         :due_date => Date.new(2013, 6, 1),
@@ -84,7 +84,7 @@ describe Invoicexpress::Client::CreditNotes do
       expect { cnote = @client.update_credit_note_state(1423940, state) }.to_not raise_error
     end
   end
- 
+
   describe ".credit_note_mail" do
     it "sends the credit note through email" do
       stub_put("/credit_notes/1423940/email-document.xml").

data/spec/invoicexpress/client/invoices_spec.rb

@@ -2,7 +2,7 @@ require 'helper'
 
 describe Invoicexpress::Client::Invoices do
   before do
-    @client = Invoicexpress::Client.new(:screen_name => "thinkorangeteste")
+    @client = Invoicexpress::Client.new(:account_name => "thinkorangeteste")
   end
 
   describe ".invoices" do
@@ -21,7 +21,7 @@ describe Invoicexpress::Client::Invoices do
       stub_post("/invoices.xml").
         to_return(xml_response("invoices.create.xml"))
 
-      
+
       object = Invoicexpress::Models::Invoice.new(
         :date => Date.new(2013, 6, 18),
         :due_date => Date.new(2013, 6, 18),
@@ -79,7 +79,7 @@ describe Invoicexpress::Client::Invoices do
       }.to raise_error(ArgumentError)
     end
   end
- 
+
   describe ".update_invoice_state" do
     it "updates the state" do
       stub_put("/invoices/1503698/change-state.xml").
@@ -91,7 +91,7 @@ describe Invoicexpress::Client::Invoices do
       expect { @client.update_invoice_state(1503698, state) }.to_not raise_error
     end
   end
- 
+
   describe ".email_invoice" do
     it "sends the invoice through email" do
       stub_put("/invoice/1503698/email-invoice.xml").

data/spec/invoicexpress/client/purchase_orders_spec.rb

@@ -2,7 +2,7 @@ require 'helper'
 
 describe Invoicexpress::Client::PurchaseOrders do
   before do
-    @client = Invoicexpress::Client.new(:screen_name => "thinkorangeteste")
+    @client = Invoicexpress::Client.new(:account_name => "thinkorangeteste")
   end
 
   describe ".purchase_orders" do
@@ -20,7 +20,7 @@ describe Invoicexpress::Client::PurchaseOrders do
     it "creates a new purchase order" do
       stub_post("/purchase_orders.xml").
         to_return(xml_response("po.create.xml"))
-            
+
       object = Invoicexpress::Models::PurchaseOrder.new(
         :date => Date.new(2013, 5, 30),
         :due_date => Date.new(2013, 8, 8),
@@ -82,7 +82,7 @@ describe Invoicexpress::Client::PurchaseOrders do
       }.to raise_error(ArgumentError)
     end
   end
- 
+
 
   describe ".update_purchase_order_state" do
     it "updates the state" do
@@ -96,7 +96,7 @@ describe Invoicexpress::Client::PurchaseOrders do
       expect { item = @client.update_purchase_order_state(1430338, state) }.to_not raise_error
     end
   end
- 
+
   describe ".simplified_invoice_mail" do
     it "sends the invoice through email" do
       stub_put("/purchase_orders/1430338/email-document.xml").

data/spec/invoicexpress/client/schedules_spec.rb

@@ -2,7 +2,7 @@ require 'helper'
 
 describe Invoicexpress::Client::Schedules do
   before do
-    @client = Invoicexpress::Client.new(:screen_name => "thinkorangeteste")
+    @client = Invoicexpress::Client.new(:account_name => "thinkorangeteste")
   end
 
   describe ".schedules" do

data/spec/invoicexpress/client/sequences_spec.rb

@@ -2,7 +2,7 @@ require 'helper'
 
 describe Invoicexpress::Client::Sequences do
   before do
-    @client = Invoicexpress::Client.new(:screen_name => "thinkorangeteste")
+    @client = Invoicexpress::Client.new(:account_name => "thinkorangeteste")
   end
 
   describe ".sequences" do

data/spec/invoicexpress/client/simplified_invoices_spec.rb

@@ -2,7 +2,7 @@ require 'helper'
 
 describe Invoicexpress::Client::SimplifiedInvoices do
   before do
-    @client = Invoicexpress::Client.new(:screen_name => "thinkorangeteste")
+    @client = Invoicexpress::Client.new(:account_name => "thinkorangeteste")
   end
 
   describe ".simplified_invoices" do
@@ -21,7 +21,7 @@ describe Invoicexpress::Client::SimplifiedInvoices do
       stub_post("/simplified_invoices.xml").
         to_return(xml_response("simplified_invoices.create.xml"))
 
-      
+
       object = Invoicexpress::Models::SimplifiedInvoice.new(
         :date => Date.new(2013, 5, 1),
         :due_date => Date.new(2013, 6, 1),
@@ -84,7 +84,7 @@ describe Invoicexpress::Client::SimplifiedInvoices do
       }.to raise_error(ArgumentError)
     end
   end
- 
+
   describe ".update_simplified_invoice_state" do
     it "updates the state" do
       stub_put("/simplified_invoices/1425061/change-state.xml").
@@ -96,7 +96,7 @@ describe Invoicexpress::Client::SimplifiedInvoices do
       expect { item = @client.update_simplified_invoice_state(1425061, state) }.to_not raise_error
     end
   end
- 
+
   describe ".simplified_invoice_mail" do
     it "sends the invoice through email" do
       stub_put("/simplified_invoices/1425061/email-document.xml").

data/spec/invoicexpress/client/taxes_spec.rb

@@ -2,7 +2,7 @@ require 'helper'
 
 describe Invoicexpress::Client::Taxes do
   before do
-    @client = Invoicexpress::Client.new(:screen_name => "thinkorangeteste")
+    @client = Invoicexpress::Client.new(:account_name => "thinkorangeteste")
   end
 
   describe ".taxes" do

data/spec/invoicexpress/client/users_spec.rb

@@ -3,7 +3,7 @@ require 'helper'
 describe Invoicexpress::Client::Clients do
 
   before do
-    @client = Invoicexpress::Client.new(:screen_name => "thinkorangeteste")
+    @client = Invoicexpress::Client.new(:account_name => "thinkorangeteste")
   end
 
   describe ".login" do
@@ -27,12 +27,12 @@ describe Invoicexpress::Client::Clients do
       list.first.name.should == "thinkorangeteste"
     end
   end
-  
+
   describe ".change-account" do
     it "changes the current account to the account id submitted" do
       stub_put("/users/change-account.xml").
         to_return(xml_response("users.change-account.xml"))
-        
+
       expect { cnote = @client.change_account(13233) }.to_not raise_error
     end
   end

data/spec/invoicexpress/request_spec.rb

@@ -0,0 +1,72 @@
+require 'helper'
+
+RSpec.describe Invoicexpress::Request do
+  let (:path) { '' }
+  let (:klass) { Class.new { include HappyMapper } }
+
+  shared_examples 'an account_name validator' do
+    context 'given a client with no account_name' do
+      let (:client) { Invoicexpress.new }
+
+      before do
+        stub_request(:any, 'https://.app.invoicexpress.com/')
+          .to_raise(Faraday::ConnectionFailed.new(
+            'getaddrinfo: nodename nor servname provided, or not known'))
+      end
+
+      it 'raises a BadAddress error with a helpful suggestion' do
+        expect { subject }.to raise_error(
+          Invoicexpress::BadAddress, /forget.+account_name/)
+      end
+    end
+
+    context 'given a client with options' do
+      let (:client) { Invoicexpress.new options }
+
+      before { stub_request :any, 'https://test.app.invoicexpress.com/' }
+
+      context 'given an account_name' do
+        let (:options) { { account_name: 'test' } }
+
+        it 'sets the correct account subdomain' do
+          subject
+          assert_requested :any, 'https://test.app.invoicexpress.com/', times: 1
+        end
+      end
+
+      context 'given an screen_name' do
+        let (:options) { { screen_name: 'test' } }
+
+        it 'sets the correct account subdomain' do
+          subject
+          assert_requested :any, 'https://test.app.invoicexpress.com/', times: 1
+        end
+      end
+    end
+  end
+
+  describe '.delete' do
+    subject (:delete) { client.delete path, klass: klass }
+    it_behaves_like 'an account_name validator'
+  end
+
+  describe '.get' do
+    subject (:get) { client.get path, klass: klass }
+    it_behaves_like 'an account_name validator'
+  end
+
+  describe '.patch' do
+    subject (:patch) { client.patch path, klass: klass }
+    it_behaves_like 'an account_name validator'
+  end
+
+  describe '.post' do
+    subject (:post) { client.post path, klass: klass }
+    it_behaves_like 'an account_name validator'
+  end
+
+  describe '.put' do
+    subject (:put) { client.put path, klass: klass }
+    it_behaves_like 'an account_name validator'
+  end
+end

metadata

@@ -1,93 +1,87 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: invoicexpress
-version: !ruby/object:Gem::Version 
-  hash: 11
+version: !ruby/object:Gem::Version
+  version: 0.1.9
   prerelease: 
-  segments: 
-  - 0
-  - 1
-  - 8
-  version: 0.1.8
 platform: ruby
-authors: 
+authors:
 - Think Orange
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2015-08-10 00:00:00 +01:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2015-12-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: bundler
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 15
-        segments: 
-        - 1
-        - 0
-        version: "1.0"
+      - !ruby/object:Gem::Version
+        version: '1.0'
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: faraday
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 27
-        segments: 
-        - 0
-        - 8
-        version: "0.8"
+      - !ruby/object:Gem::Version
+        version: '0.8'
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: faraday_middleware
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 25
-        segments: 
-        - 0
-        - 9
-        version: "0.9"
+      - !ruby/object:Gem::Version
+        version: '0.9'
   type: :runtime
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: happymapper
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: happymapper
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        - 4
-        version: "0.4"
+      - !ruby/object:Gem::Version
+        version: '0.4'
   type: :runtime
-  version_requirements: *id004
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
 description: Simple wrapper for invoicexpress.com API
-email: 
+email:
 - info@thinkorange.pt
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - CHANGELOG.md
 - README.md
 - Rakefile
@@ -185,44 +179,34 @@ files:
 - spec/invoicexpress/client/users_spec.rb
 - spec/invoicexpress/client_spec.rb
 - spec/invoicexpress/models/item_spec.rb
+- spec/invoicexpress/request_spec.rb
 - spec/invoicexpress_spec.rb
-has_rdoc: true
 homepage: http://invoicexpress.com
-licenses: 
+licenses:
 - MIT
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 23
-      segments: 
-      - 1
-      - 3
-      - 6
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.23.2
 signing_key: 
 specification_version: 3
 summary: Simple wrapper for invoicexpress.com API
-test_files: 
+test_files:
 - spec/fixtures/charts.invoicing.xml
 - spec/fixtures/charts.quarterly-results.xml
 - spec/fixtures/charts.top-clients.xml
@@ -280,4 +264,6 @@ test_files:
 - spec/invoicexpress/client/users_spec.rb
 - spec/invoicexpress/client_spec.rb
 - spec/invoicexpress/models/item_spec.rb
+- spec/invoicexpress/request_spec.rb
 - spec/invoicexpress_spec.rb
+has_rdoc: