invoicexpress 0.1.2 → 0.1.8

data/CHANGELOG.md

@@ -1,8 +1,30 @@
+#Version 0.1.8
+Added city field to client.
+
+# Version 0.1.7
+Fix issue #7 - Wrong return type of Modes::Item#tax
+Added Travis
+
+# Version 0.1.6.1
+Renamed the invoice_email method to email_invoice for sending email. Extracted examples to own file.
+
+# Version 0.1.6
+Fixed url for send email. New url: http://invoicexpress.com/api/invoices/email-invoice
+
+# Version 0.1.5
+Added rate to invoice. Experimental.
+
+# Version 0.1.4.1
+Added language field to client. API endpoint now defaults to https://%s.app.invoicexpress.com/
+
+# Version 0.1.3
+Removed "rquire 'pry'". Fixed it for production.
+
 # Version 0.1.2
 Corrected information in gem.
 
 # Version 0.1.1
-Fixed bug with latest version of Faraday (~>0.9.0) which prevented creating a new client.
+Fixed bug with latest version of Faraday (>0.9.0) which prevented creating a new client.
 
 # Version 0.1.0
 Release!

data/README.md

@@ -49,6 +49,7 @@ We've included docs for all methods. Refer to the doc folder and client section.
 ## Examples
 
 If using from inside a rails project use:
+
     require 'invoicexpress'
  
     client = Invoicexpress::Client.new(
@@ -56,270 +57,5 @@ If using from inside a rails project use:
       :api_key     => "yourapikey"
     )
 
-Here's some examples for the most common objects and endpoints. You could also take a look at the spec folder for extensive tests.
-
-### Simplified Invoices
-
-    simple_invoices = @client.simplified_invoices
-    puts simple_invoices
-
-    invoice = Invoicexpress::Models::SimplifiedInvoice.new(
-      :date => Date.new(2013, 6, 16),
-      :due_date => Date.new(2013, 6, 16),
-      :tax_exemption => "M01",
-      :observations=> 'new',
-      :client => Invoicexpress::Models::Client.new(
-        :name => "Pedro Sousa",
-        :email=> 'psousa@thinkorange.pt'
-      ),
-      :items => [
-        Invoicexpress::Models::Item.new(
-          :name => "Item 6",
-          :unit_price => 120,
-          :quantity => 2,
-          :unit => "unit",
-        ),
-        Invoicexpress::Models::Item.new(
-          :name => "Item AM",
-          :unit_price => 50,
-          :quantity => 1,
-          :unit => "unit",
-        )
-      ]
-    )
-    simple_invoice = @client.create_simplified_invoice(invoice)
-    simple_invoice = @client.simplified_invoice(1425061)
-    simple_invoice.tax_exemption="M02"
-    @client.update_simplified_invoice(simple_invoice)
-    state = Invoicexpress::Models::InvoiceState.new(
-      :state => "finalized"
-    )
-    @client.update_simplified_invoice_state(simple_invoice.id, state)
-
-### Credit Notes
-
-        credit_notes = @client.credit_notes
-        puts credit_notes
-
-        cnote = Invoicexpress::Models::CreditNote.new(
-          :date => Date.new(2013, 6, 11),
-          :due_date => Date.new(2013, 6, 11),
-          :tax_exemption => "M01",
-          :client => Invoicexpress::Models::Client.new(
-            :name => "Pedro Sousa",
-            :email=> 'psousa@thinkorange.pt'
-          ),
-          :items => [
-            Invoicexpress::Models::Item.new(
-              :name => "Item 1",
-              :unit_price => 60,
-              :quantity => 2,
-              :unit => "unit",
-            ),
-            Invoicexpress::Models::Item.new(
-              :name => "Item 2",
-              :unit_price => 50,
-              :quantity => 1,
-              :unit => "unit",
-            )
-          ]
-        )
-        cnote = @client.create_credit_note(cnote)
-        cnote_load = @client.credit_note(cnote.id)
-        cnote_load.tax_exemption="M02"
-        @client.update_credit_note(cnote_load)
-        state = Invoicexpress::Models::InvoiceState.new(
-          :state => "finalized"
-        )
-        @client.update_credit_note_state(cnote_load.id, state)
-
-### Debit Notes
-
-
-        debit_notes = @client.debit_notes
-        puts debit_notes
-
-        dnote = Invoicexpress::Models::DebitNote.new(
-          :date => Date.new(2013, 5, 1),
-          :due_date => Date.new(2013, 6, 1),
-          :tax_exemption => "M01",
-          :client => Invoicexpress::Models::Client.new(
-            :name => "Pedro Sousa",
-            :email=> 'psousa@thinkorange.pt'
-          ),
-          :items => [
-            Invoicexpress::Models::Item.new(
-              :name => "Item 1",
-              :unit_price => 60,
-              :quantity => 2,
-              :unit => "unit",
-            )
-          ]
-        )
-        dnote = @client.create_debit_note(dnote)
-        dnote_loaded = @client.debit_note(1503654)
-        dnote.tax_exemption="M02"
-        @client.update_debit_note(dnote)
-        state = Invoicexpress::Models::InvoiceState.new(
-          :state => "finalized"
-        )
-        dnote = @client.update_credit_note_state(dnote.id, state)
-
-### Invoices
-
-        invoices = @client.invoices
-        invoices.invoices.count
-        invoices.current_page
-        puts invoices
-
-        invoice = @client.invoice(1042320)
-
-        invoice = Invoicexpress::Models::Invoice.new(
-          :date => Date.new(2013, 6, 18),
-          :due_date => Date.new(2013, 6, 18),
-          :tax_exemption => "M01",
-          :client => Invoicexpress::Models::Client.new(
-            :name => "Ruben Fonseca"
-          ),
-          :items => [
-            Invoicexpress::Models::Item.new(
-              :name => "Item 1",
-              :unit_price => 30,
-              :quantity => 1,
-              :unit => "unit",
-            )
-          ]
-        )
-        invoice = @client.create_invoice(invoice)
-
-        invoice.observations="updated from api"
-        @client.update_invoice(invoice)
-
-        invoice_state = Invoicexpress::Models::InvoiceState.new(
-          :state => "finalized"
-        )
-        @client.update_invoice_state(invoice.id, invoice_state)
-
-        message = Invoicexpress::Models::Message.new(
-          :client => Invoicexpress::Models::Client.new(
-            :email => "info@thinkorange.pt",
-            :name=>"Chuck Norris"
-          ),
-          :subject => "Your invoice",
-          :body => "Attached to this email"
-        )
-        @client.invoice_email(invoice.id, message)
-
-### Charts
-
-        chart_i = @client.invoicing_chart
-        chart_t = @client.treasury_chart
-        top_c = @client.top_clients
-        top_d = @client.top_debtors
-        quarter = @client.quarterly_results(2011)
-      
-### Schedules
-
-
-        new_schedule = Invoicexpress::Models::Schedule.new(
-          :start_date => Date.new(2013, 6, 16),
-          :end_date => Date.new(2013, 8, 18),
-          :create_back => "Yes",
-          :schedule_type => "Monthly",
-          :interval => 2,
-          :send_to_client => "No",
-          :description=> "created from API.",
-          :invoice_template=> Invoicexpress::Models::InvoiceTemplate.new(
-            :due_days=>1,
-            :client => Invoicexpress::Models::Client.new(
-              :name => "Rui Leitão",
-              :email=>'rmleitao@thinkorange.pt'
-            ),
-            :items => [
-              Invoicexpress::Models::Item.new(
-                :name => "Item 1",
-                :unit_price => 30,
-                :quantity => 2,
-                :unit => "unit",
-                :tax=>Invoicexpress::Models::Tax.new(
-                  :name => "IVA23",
-                )
-              ),
-              Invoicexpress::Models::Item.new(
-                :name => "Item 2",
-                :unit_price => 60,
-                :quantity => 5,
-                :unit => "unit",
-                :tax=>Invoicexpress::Models::Tax.new(
-                  :name => "IVA23",
-                )
-              )
-            ]
-          )
-        )
-        schedule = @client.create_schedule(new_schedule)
-
-To update a schedule we need to pass these fields.
-
-        schedule.invoice_template=Invoicexpress::Models::InvoiceTemplate.new(
-            :due_days=>1,
-            :client => Invoicexpress::Models::Client.new(
-              :name => "Rui Leitão",
-              :email=>'rmleitao@thinkorange.pt'
-            ),
-            :items => [
-              Invoicexpress::Models::Item.new(
-                :name => "Item 1",
-                :unit_price => 30,
-                :quantity => 2,
-                :unit => "unit",
-                :tax=>Invoicexpress::Models::Tax.new(
-                  :name => "IVA23",
-                )
-              ),
-              Invoicexpress::Models::Item.new(
-                :name => "Item 2",
-                :unit_price => 60,
-                :quantity => 5,
-                :unit => "unit",
-                :tax=>Invoicexpress::Models::Tax.new(
-                  :name => "IVA23",
-                )
-              )
-            ]
-          )
-        schedule.interval=2
-        schedule.schedule_type="Monthly"
-        schedule.send_to_client="No"
-        schedule.description="Maybe"
-        schedule.create_back="No"
-        @client.update_schedule(schedule)
-
-        @client.activate schedule
-        @client.deactivate_schedule schedule
-
-### Purchase Orders
-
+Examples for API are located in the EXAMPLES.md file.
 
-        orders=@client.purchase_orders
-        purchase_order = Invoicexpress::Models::PurchaseOrder.new(
-          :date => Date.new(2013, 5, 30),
-          :due_date => Date.new(2013, 8, 8),
-          :loaded_at => Date.new(2013, 5, 30),
-          :delivery_site=>'LX',
-          :supplier => Invoicexpress::Models::Supplier.new(
-            :name => "Pedro Sousa",
-          ),
-          :items => [
-            Invoicexpress::Models::Item.new(
-              :name => "Item 1",
-              :unit_price => 60,
-              :quantity => 2,
-              :unit => "unit",
-              :tax=> Invoicexpress::Models::Tax.new(
-                :name=>'IVA23'
-              )
-            )
-          ]
-        )
-        purchase_order = @client.create_purchase_order(purchase_order)

data/lib/faraday/response/parse_xml.rb

@@ -1,5 +1,5 @@
 require 'faraday'
-# require 'pry'
+#require 'pry'
 
 # @api private
 module Faraday

data/lib/invoicexpress/client/cash_invoices.rb

@@ -91,19 +91,6 @@ module Invoicexpress
         put("cash_invoices/#{invoice_id}/change-state.xml", params.merge(options))
       end
 
-      # Sends the invoice by email
-      #
-      # @param invoice_id [String] The cash invoice id to change
-      # @param message [Invoicexpress::Models::Message] The message to send
-      # @raise Invoicexpress::Unauthorized When the client is unauthorized
-      # @raise Invoicexpress::UnprocessableEntity When there are errors on the submission
-      # @raise Invoicexpress::NotFound When the invoice doesn't exist
-      def invoice_email(invoice_id, message, options={})
-        raise(ArgumentError, "message has the wrong type") unless message.is_a?(Invoicexpress::Models::Message)
-
-        params = { :body => message, :klass => Invoicexpress::Models::CashInvoice }
-        put("cash_invoices/#{invoice_id}/email-document.xml", params.merge(options))
-      end
 
     end
   end

data/lib/invoicexpress/client/invoices.rb

@@ -95,13 +95,19 @@ module Invoicexpress
       # @raise Invoicexpress::Unauthorized When the client is unauthorized
       # @raise Invoicexpress::UnprocessableEntity When there are errors on the submission
       # @raise Invoicexpress::NotFound When the invoice doesn't exist
-      def invoice_mail(invoice_id, message, options={})
+      def email_invoice(invoice_id, message, options={})
         raise(ArgumentError, "message has the wrong type") unless message.is_a?(Invoicexpress::Models::Message)
 
         params = { :body => message, :klass => Invoicexpress::Models::Invoice }
-        put("invoices/#{invoice_id}/email-invoice.xml", params.merge(options))
+        put("invoice/#{invoice_id}/email-invoice.xml", params.merge(options))
       end
 
+      #deprecated
+      def invoice_email(invoice_id, message, options={})
+        email_invoice(invoice_id, message, options)
+      end
+
+
     end
   end
 end

data/lib/invoicexpress/configuration.rb

@@ -14,7 +14,7 @@ module Invoicexpress
     ].freeze
 
     DEFAULT_ADAPTER = Faraday.default_adapter
-    DEFAULT_API_ENDPOINT = ENV['INVOICEXPRESS_API_ENDPOINT'] || 'https://%s.invoicexpress.net/'
+    DEFAULT_API_ENDPOINT = ENV['INVOICEXPRESS_API_ENDPOINT'] || 'https://%s.app.invoicexpress.com/'
     DEFAULT_USER_AGENT = "Invoicexpress Ruby Gem #{Invoicexpress::VERSION}".freeze
 
     attr_accessor(*VALID_OPTIONS_KEYS)
@@ -22,7 +22,7 @@ module Invoicexpress
     def self.extended(base)
       base.reset
     end
-    
+
     def configure
       yield self
     end

data/lib/invoicexpress/models/client.rb

@@ -18,6 +18,8 @@ module Invoicexpress
       element :send_options, Integer
       element :balance, Float
       element :country, String
+      element :language, String
+      element :city, String
     end
 
   end

data/lib/invoicexpress/models/invoice.rb

@@ -52,6 +52,10 @@ module Invoicexpress
           element :tax_exemption, String
           element :sequence_id, Integer
           element :mb_reference, String
+
+          element :rate, String
+          element :currency_code, String
+
           has_one :client, Client
           has_many :items, Item, :on_save => Proc.new { |value|
             Items.new(:items => value)

data/lib/invoicexpress/version.rb

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

data/spec/fixtures/clients.create.xml

@@ -3,4 +3,5 @@
   <id>1</id>
   <name>Ruben Fonseca</name>
   <email>fonseka@gmail.com</email>
+  <city>Lisboa</city>
 </client>

data/spec/fixtures/clients.list.xml

@@ -10,6 +10,7 @@
     <website/>
     <phone/>
     <fax/>
+    <city>Lisboa</city>
     <preferred_contact>
     </preferred_contact>
     <observations/>

data/spec/helper.rb

@@ -56,7 +56,7 @@ def invoicexpress_url(url)
   if url =~ /^http/
     url
   else
-    "https://thinkorangeteste.invoicexpress.net#{url}"
+    "https://thinkorangeteste.app.invoicexpress.com#{url}"
   end
 end
 

data/spec/invoicexpress/client/clients_spec.rb

@@ -15,6 +15,7 @@ describe Invoicexpress::Client::Clients do
       list.count.should == 1
       list.first.name.should == "Ruben Fonseca"
       list.first.email.should == "fonseka@gmail.com"
+      list.first.city.should == "Lisboa"
     end
   end
 
@@ -25,12 +26,14 @@ describe Invoicexpress::Client::Clients do
 
       model_client = Invoicexpress::Models::Client.new({
         :name => "Ruben Fonseca",
-        :email => "fonseka@gmail.com"
+        :email => "fonseka@gmail.com",
+        :city => "Lisboa"
       })
 
       new_client = @client.create_client(model_client)
       new_client.name.should == "Ruben Fonseca"
       new_client.email.should == "fonseka@gmail.com"
+      new_client.city.should == "Lisboa"
     end
 
     it "raises if no client is passed" do

data/spec/invoicexpress/client/invoices_spec.rb

@@ -92,9 +92,9 @@ describe Invoicexpress::Client::Invoices do
     end
   end
  
-  describe ".invoice_mail" do
+  describe ".email_invoice" do
     it "sends the invoice through email" do
-      stub_put("/invoices/1503698/email-invoice.xml").
+      stub_put("/invoice/1503698/email-invoice.xml").
         to_return(xml_response("ok.xml"))
       message = Invoicexpress::Models::Message.new(
         :subject => "Hello world",
@@ -104,7 +104,7 @@ describe Invoicexpress::Client::Invoices do
           :email=> 'info@thinkorange.pt'
         )
       )
-      expect { @client.invoice_mail(1503698, message) }.to_not raise_error
+      expect { @client.email_invoice(1503698, message) }.to_not raise_error
     end
   end
 end

data/spec/invoicexpress/client_spec.rb

@@ -6,19 +6,19 @@ describe Invoicexpress::Client do
   end
 
   describe "api_endpoint" do
-    after(:each) do 
+    after(:each) do
       Invoicexpress.reset
     end
 
-    it "defauls to https://%s.invoicexpress.net" do
+    it "defaults to https://%s.app.invoicexpress.com/" do
       client = Invoicexpress::Client.new
-      client.api_endpoint.should == "https://%s.invoicexpress.net/"
+      client.api_endpoint.should == "https://%s.app.invoicexpress.com/"
     end
 
     it "is set" do
-      Invoicexpress.api_endpoint = "https://thinkorangeteste.invoicexpress.net/"
+      Invoicexpress.api_endpoint = "https://thinkorangeteste.app.invoicexpress.com/"
       client = Invoicexpress::Client.new
-      client.api_endpoint.should == "https://thinkorangeteste.invoicexpress.net/"
+      client.api_endpoint.should == "https://thinkorangeteste.app.invoicexpress.com/"
     end
   end
 end

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: invoicexpress
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  hash: 11
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 8
+  version: 0.1.8
 platform: ruby
 authors: 
 - Think Orange
@@ -9,15 +15,21 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2015-02-23 00:00:00 Z
+date: 2015-08-10 00:00:00 +01:00
+default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: bundler
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
         version: "1.0"
   type: :development
   version_requirements: *id001
@@ -25,9 +37,14 @@ dependencies:
   name: faraday
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 0
+        - 8
         version: "0.8"
   type: :runtime
   version_requirements: *id002
@@ -35,9 +52,14 @@ dependencies:
   name: faraday_middleware
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 0
+        - 9
         version: "0.9"
   type: :runtime
   version_requirements: *id003
@@ -45,9 +67,14 @@ dependencies:
   name: happymapper
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        - 4
         version: "0.4"
   type: :runtime
   version_requirements: *id004
@@ -67,9 +94,7 @@ files:
 - invoicexpress.gemspec
 - lib/faraday/response/parse_xml.rb
 - lib/faraday/response/raise_invoicexpress_errors.rb
-- lib/invoicexpress.rb
 - lib/invoicexpress/authentication.rb
-- lib/invoicexpress/client.rb
 - lib/invoicexpress/client/cash_invoices.rb
 - lib/invoicexpress/client/charts.rb
 - lib/invoicexpress/client/clients.rb
@@ -83,10 +108,10 @@ files:
 - lib/invoicexpress/client/simplified_invoices.rb
 - lib/invoicexpress/client/taxes.rb
 - lib/invoicexpress/client/users.rb
+- lib/invoicexpress/client.rb
 - lib/invoicexpress/configuration.rb
 - lib/invoicexpress/connection.rb
 - lib/invoicexpress/error.rb
-- lib/invoicexpress/models.rb
 - lib/invoicexpress/models/chart.rb
 - lib/invoicexpress/models/client.rb
 - lib/invoicexpress/models/filter.rb
@@ -99,8 +124,10 @@ files:
 - lib/invoicexpress/models/top_client.rb
 - lib/invoicexpress/models/top_debtor.rb
 - lib/invoicexpress/models/user.rb
+- lib/invoicexpress/models.rb
 - lib/invoicexpress/request.rb
 - lib/invoicexpress/version.rb
+- lib/invoicexpress.rb
 - spec/fixtures/charts.invoicing.xml
 - spec/fixtures/charts.quarterly-results.xml
 - spec/fixtures/charts.top-clients.xml
@@ -159,32 +186,41 @@ files:
 - spec/invoicexpress/client_spec.rb
 - spec/invoicexpress/models/item_spec.rb
 - spec/invoicexpress_spec.rb
+has_rdoc: true
 homepage: http://invoicexpress.com
 licenses: 
 - MIT
-metadata: {}
-
 post_install_message: 
 rdoc_options: []
 
 require_paths: 
 - lib
 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 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
       version: 1.3.6
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 1.6.2
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Simple wrapper for invoicexpress.com API
 test_files: 
 - spec/fixtures/charts.invoicing.xml

checksums.yaml

@@ -1,7 +0,0 @@
---- 
-SHA512: 
-  metadata.gz: 923e045ee7caffb6f89b8d22c0e46b0b31787f6ffef0d55e07b7564044a685453544471b6209be5e8980ff0e641296403cca396fca6598af43dc0df0e1d438d2
-  data.tar.gz: b69aed1e5ea804a0392cf7f982b5f07cef15c355e257f7e628ba41d584b00354543f9dd9993042722d3d7dbe2093b8698baf5583ad2feb43ab249943ef5bdd02
-SHA1: 
-  metadata.gz: 69ecdffcd7f1b586de19dd3f49606c98e6fff2bc
-  data.tar.gz: 544dc6509fb55a744e339875dd124e3fc321719c