badbill 0.0.1 → 0.1.0

data/CONTRIBUTING.md

@@ -1,6 +1,6 @@
 # How to contribute
 
-This API client is implemented for my own use, so I will only work on the parts I need for myself.
+This API client is implemented for use at [rrbone](http://www.rrbone.net), so I will only work on the parts we need for our application.
 Additional improvements, comments on code and implementation and bug fixes are very welcome.
 
 ## Report bugs, improvements or feature requests
@@ -8,6 +8,9 @@ Additional improvements, comments on code and implementation and bug fixes are v
 * Submit a ticket for your issue, assuming one does not already exist.
   * Clearly describe the issue including steps to reproduce when it is a bug.
   * Make sure you fill in the earliest version that you know has the issue.
+* If you need a resource implemented in Ruby, but does not know how to do it
+  the right way, just contact me or open an issue. I will try to find time to
+  implement any needed things.
 
 ## Making Changes
 
@@ -30,5 +33,5 @@ Additional improvements, comments on code and implementation and bug fixes are v
 
 Feel free to contact me with any issues or questions.
 
-* Mail: badboy@archlinux.us
+* Mail: jer@rrbone.net
 * Twitter: [@badboy_](https://twitter.com/badboy_)

data/Gemfile

@@ -1,9 +1,20 @@
 source 'https://rubygems.org'
 
 group :development do
-  gem 'yard'
-  gem 'redcarpet'
-  gem 'simplecov'
+  gem 'yard', '~> 0.8.2'
+  gem 'redcarpet', '~> 2.1.1'
+  gem 'simplecov', '~> 0.6.4'
+
+  gem 'guard-rspec', '~> 2.0.0'
+  gem 'fuubar', '~> 1.1.0'        # Guard output mode
+  gem 'rb-inotify', '~> 0.8.0'    # Notification of test status (used by guard)
+end
+
+group :test do
+  gem 'rake'
+  gem 'webmock', '~> 1.9.0'
+  gem 'vcr', '~> 2.4.0'
+  gem 'rspec', '~> 2.11.0'
 end
 
 gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    badbill (0.0.1)
+    badbill (0.0.3dev)
       faraday
       faraday_middleware
       hashie
@@ -10,16 +10,41 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.3.2)
-    crack (0.3.1)
+    addressable (2.3.3)
+    coderay (1.0.9)
+    crack (0.3.2)
     diff-lcs (1.1.3)
-    faraday (0.8.4)
+    faraday (0.8.6)
       multipart-post (~> 1.1)
-    faraday_middleware (0.8.8)
+    faraday_middleware (0.9.0)
       faraday (>= 0.7.4, < 0.9)
-    hashie (1.2.0)
-    multi_json (1.3.6)
+    ffi (1.4.0)
+    fuubar (1.1.0)
+      rspec (~> 2.0)
+      rspec-instafail (~> 0.2.0)
+      ruby-progressbar (~> 1.0.0)
+    guard (1.6.2)
+      listen (>= 0.6.0)
+      lumberjack (>= 1.0.2)
+      pry (>= 0.9.10)
+      terminal-table (>= 1.4.3)
+      thor (>= 0.14.6)
+    guard-rspec (2.0.0)
+      guard (>= 1.1)
+      rspec (~> 2.11)
+    hashie (2.0.1)
+    listen (0.7.3)
+    lumberjack (1.0.2)
+    method_source (0.8.1)
+    multi_json (1.6.1)
     multipart-post (1.1.5)
+    pry (0.9.12)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rake (10.0.3)
+    rb-inotify (0.8.8)
+      ffi (>= 0.5.0)
     redcarpet (2.1.1)
     rspec (2.11.0)
       rspec-core (~> 2.11.0)
@@ -28,24 +53,35 @@ GEM
     rspec-core (2.11.1)
     rspec-expectations (2.11.3)
       diff-lcs (~> 1.1.3)
+    rspec-instafail (0.2.4)
     rspec-mocks (2.11.3)
+    ruby-progressbar (1.0.2)
     simplecov (0.6.4)
       multi_json (~> 1.0)
       simplecov-html (~> 0.5.3)
     simplecov-html (0.5.3)
-    webmock (1.8.10)
+    slop (3.4.3)
+    terminal-table (1.4.5)
+    thor (0.17.0)
+    vcr (2.4.0)
+    webmock (1.9.3)
       addressable (>= 2.2.7)
-      crack (>= 0.1.7)
+      crack (>= 0.3.2)
     yajl-ruby (1.1.0)
-    yard (0.8.2.1)
+    yard (0.8.5.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   badbill!
-  redcarpet
-  rspec
-  simplecov
-  webmock
-  yard
+  fuubar (~> 1.1.0)
+  guard-rspec (~> 2.0.0)
+  rake
+  rb-inotify (~> 0.8.0)
+  redcarpet (~> 2.1.1)
+  rspec (~> 2.11.0)
+  simplecov (~> 0.6.4)
+  vcr (~> 2.4.0)
+  webmock (~> 1.9.0)
+  yard (~> 0.8.2)

data/Guardfile

@@ -0,0 +1,6 @@
+guard 'rspec', cli: '--drb --format Fuubar --color', version: 2 do
+  # run every updated spec file
+  watch(%r{^spec/.+_spec\.rb$})
+  # run the lib specs when a file in lib/ changes
+  watch(%r{^lib/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
+end

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012 Jan-Erik Rediger <http://fnordig.de/about/>
+Copyright (c) 2012 Jan-Erik Rediger <jer@rrbone.net>
 
 Permission  is  hereby granted, free of charge, to any person ob-
 taining a copy of  this  software  and  associated  documentation

data/README.md

@@ -1,6 +1,8 @@
 BadBill - Billomat API Client
 ===================
 
+(developed for internal use at [rrbone](http://www.rrbone.net))
+
 Simple but working API client for the [Billomat API][apidocu].
 
 See the [API documentation][apidocu] for full documentation of all resources.
@@ -19,10 +21,13 @@ The basic BadBill class allows access to all resources. It includes no syntactic
 
 The following resources are currently implemented as its own class:
 
-* [clients](http://www.billomat.com/en/api/invoices/) (`BadBill::Client`)
-* [invoices](http://www.billomat.com/en/api/invoices/) (`BadBill::Invoices`)
+* [clients](http://www.billomat.com/en/api/clients/) (`BadBill::Client`)
+* [invoices](http://www.billomat.com/en/api/invoices/) (`BadBill::Invoice`)
+* [invoice-payments](http://www.billomat.com/en/api/invoices/payments/) (`BadBill::InvoicePayment`)
+* [invoice-items](http://www.billomat.com/en/api/invoices/items/) (`BadBill::InvoiceItem`)
+* [invoice-comments](http://www.billomat.com/en/api/invoices/comments) (`BadBill::InvoiceComment`)
+* [recurring](http://www.billomat.com/en/api/recurrings/) (`BadBill::Recurring`)
 
-These are the two I need right now.
 Implementing new resources is easy. Pull Requests for others are welcome.
 
 ## Requirements

data/Rakefile

@@ -12,6 +12,10 @@ end
 task :default => :spec
 task :doc => :yard
 
+task :tags do
+  sh 'ctags -R --exclude=.git *'
+end
+
 ## helper functions
 
 def name
@@ -73,7 +77,7 @@ task :gemspec do
     split("\n").
     sort.
     reject { |file| file =~ /^\./ }.
-    reject { |file| file =~ /^(doc|coverage|pkg)/ }.
+    reject { |file| file =~ /^(doc|coverage|pkg|contrib)/ }.
     map { |file| "    ./#{file}" }.
     join("\n")
 

data/badbill.gemspec

@@ -0,0 +1,86 @@
+Gem::Specification.new do |s|
+  s.specification_version = 2 if s.respond_to? :specification_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.3.5") if s.respond_to? :required_rubygems_version=
+
+  s.name    = 'badbill'
+  s.version = '0.1.0'
+
+  s.summary     = "Simple but working API client for the Billomat API."
+  s.description = <<-EOF
+Fast and easy access to all resources the Billomat API provides (not all resources are Ruby classes, yet).
+  EOF
+
+  s.authors  = ["Jan-Erik Rediger"]
+  s.email    = 'badboy@archlinux.us'
+  s.homepage = 'https://github.com/badboy/badbill'
+
+  s.add_dependency 'yajl-ruby'
+  s.add_dependency 'faraday'
+  s.add_dependency 'faraday_middleware'
+  s.add_dependency 'hashie'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'webmock'
+
+  # = MANIFEST =
+  s.files = %w[
+    ./CONTRIBUTING.md
+    ./Gemfile
+    ./Gemfile.lock
+    ./Guardfile
+    ./LICENSE
+    ./README.md
+    ./Rakefile
+    ./badbill.gemspec
+    ./lib/badbill.rb
+    ./lib/badbill/base_resource.rb
+    ./lib/badbill/client.rb
+    ./lib/badbill/faraday_gzip.rb
+    ./lib/badbill/forward_methods.rb
+    ./lib/badbill/invoice.rb
+    ./lib/badbill/invoice_comment.rb
+    ./lib/badbill/invoice_item.rb
+    ./lib/badbill/invoice_payment.rb
+    ./lib/badbill/recurring.rb
+    ./lib/badbill/resource.rb
+    ./spec/badbill/base_resource_spec.rb
+    ./spec/badbill/client_spec.rb
+    ./spec/badbill/invoice_comment_spec.rb
+    ./spec/badbill/invoice_item_spec.rb
+    ./spec/badbill/invoice_payment_spec.rb
+    ./spec/badbill/invoice_spec.rb
+    ./spec/badbill/recurring_spec.rb
+    ./spec/badbill_spec.rb
+    ./spec/fixtures/vcr_cassettes/aggregated_invoices.yml
+    ./spec/fixtures/vcr_cassettes/all_clients.yml
+    ./spec/fixtures/vcr_cassettes/all_invoices.yml
+    ./spec/fixtures/vcr_cassettes/all_recurring_invoices.yml
+    ./spec/fixtures/vcr_cassettes/client_on_change.yml
+    ./spec/fixtures/vcr_cassettes/draft_item.yml
+    ./spec/fixtures/vcr_cassettes/existent_client.yml
+    ./spec/fixtures/vcr_cassettes/fetched_invoice_pdf.yml
+    ./spec/fixtures/vcr_cassettes/fetches_invoice-item_by_id.yml
+    ./spec/fixtures/vcr_cassettes/invoice-comments_by_invoice_id.yml
+    ./spec/fixtures/vcr_cassettes/invoice-comments_by_invoice_id_and_actionkey_PAYMENT.yml
+    ./spec/fixtures/vcr_cassettes/invoice-comments_by_invoice_id_and_actionkeys.yml
+    ./spec/fixtures/vcr_cassettes/invoice_canceled.yml
+    ./spec/fixtures/vcr_cassettes/invoice_deleted.yml
+    ./spec/fixtures/vcr_cassettes/invoice_info.yml
+    ./spec/fixtures/vcr_cassettes/invoice_marked_as_complete.yml
+    ./spec/fixtures/vcr_cassettes/invoice_payments.yml
+    ./spec/fixtures/vcr_cassettes/invoice_send_email_with_basic_info.yml
+    ./spec/fixtures/vcr_cassettes/invoice_send_email_with_basic_info_and_from.yml
+    ./spec/fixtures/vcr_cassettes/invoice_send_email_with_basic_info_from_and_subject.yml
+    ./spec/fixtures/vcr_cassettes/invoice_send_mail.yml
+    ./spec/fixtures/vcr_cassettes/invoice_send_mail_invalid_address.yml
+    ./spec/fixtures/vcr_cassettes/invoice_uploaded_signature.yml
+    ./spec/fixtures/vcr_cassettes/myself_client.yml
+    ./spec/fixtures/vcr_cassettes/new_client.yml
+    ./spec/fixtures/vcr_cassettes/non_existent_client.yml
+    ./spec/fixtures/vcr_cassettes/save_for_non-existent_client.yml
+    ./spec/fixtures/vcr_cassettes/wrong_data_for_client.yml
+    ./spec/spec_helper.rb
+  ]
+  # = MANIFEST =
+
+  s.test_files = s.files.select { |path| path =~ %r{^spec/*/.+\.rb} }
+end

data/lib/badbill.rb

@@ -1,15 +1,25 @@
 # encoding: utf-8
+#
+# Copyright (c) 2012 Jan-Erik Rediger <jer@rrbone.net>
+# See LICENSE for info.
+# Developed for internal use at rrbone (http://www.rrbone.net)
 
 require 'yajl/json_gem'
 require 'faraday_middleware'
 require 'hashie/mash'
 
+require_relative 'badbill/faraday_gzip'
+
 require_relative 'badbill/resource'
 require_relative 'badbill/forward_methods'
 require_relative 'badbill/base_resource'
 
 require_relative 'badbill/client'
 require_relative 'badbill/invoice'
+require_relative 'badbill/invoice_payment'
+require_relative 'badbill/invoice_item'
+require_relative 'badbill/invoice_comment'
+require_relative 'badbill/recurring'
 
 # Handles the connection and requests to the Billomat API.
 #
@@ -25,12 +35,14 @@ require_relative 'badbill/invoice'
 #     billo.get 'clients'
 #     # => {"clients"=>{"client"=>[...]}}
 class BadBill
-  VERSION = '0.0.1'
+  VERSION = '0.1.0'
 
   # Reject any not allowed HTTP method.
   class NotAllowedException < Exception; end
   # Fail if no global connection is set.
   class NoConnection < Exception; end
+  # Fail without API key and Billomat ID
+  class MissingConfiguration < Exception; end
 
   # The API url used for all connections.
   API_URL = 'http%s://%s.billomat.net/'
@@ -45,6 +57,10 @@ class BadBill
   def initialize billomat_id, api_key, ssl=false
     @billomat_id  = billomat_id
     @api_key      = api_key
+
+    raise MissingConfiguration.new("Billomat ID missing") if @billomat_id.nil?
+    raise MissingConfiguration.new("API Key missing")     if @api_key.nil?
+
     @ssl          = ssl
     @http_adapter = connection
 
@@ -65,6 +81,11 @@ class BadBill
     @connection
   end
 
+  def self.clear_connection
+    @connection = nil
+  end
+
+
   # Call the specified resource.
   #
   # It sets the X-BillomatApiKey header, the Content-Type header and the Accept header.
@@ -98,7 +119,15 @@ class BadBill
       req.body = options if method != :get && options && !options.empty?
     }.body
   rescue Faraday::Error::ClientError => error
-    Hashie::Mash.new :error => error
+    if error.response && error.response.has_key?(:body) && error.response[:body]
+      body = error.response[:body]
+      if !body.kind_of?(Hash) && ['{', '[', '"'].include?(body[0])
+        body = JSON.parse body
+      end
+      Hashie::Mash.new error: error, body: body
+    else
+      Hashie::Mash.new error: error
+    end
   end
 
   # Send a GET request.
@@ -143,6 +172,7 @@ class BadBill
 
       conn.response :mashify
       conn.response :json, :content_type => /\bjson$/
+      conn.response :gzip
       #conn.response :logger
       conn.response :raise_error
       conn.adapter  :net_http

data/lib/badbill/base_resource.rb

@@ -33,8 +33,19 @@ class BadBill
     # @return [Array<Resource>] All found resources.
     def self.all filter={}
       all = get resource_name, filter
-      all.__send__(resource_name).__send__(resource_name_singular).map do |res|
-        new res.id, res
+      return all if all.error
+
+      resources = all.__send__(resource_name)
+      case resources['@total'].to_i
+      when 0
+        []
+      when 1
+        data = resources.__send__(resource_name_singular)
+        [new(data.id.to_i, data)]
+      else
+        resources.__send__(resource_name_singular).map do |res|
+          new res.id.to_i, res
+        end
       end
     end
 
@@ -45,7 +56,17 @@ class BadBill
     # @return [Resource] New resource with id and data set.
     def self.find id
       c = get resource_name, id
-      new id, c.__send__(resource_name_singular)
+      if c.error
+        if c.error.kind_of? Faraday::Error::ResourceNotFound
+          return nil
+        else
+          return c
+        end
+      end
+
+      data = c.__send__(resource_name_singular)
+      return nil if data.nil?
+      new id, data
     end
 
     # Create a new resource with the given parameters.
@@ -56,17 +77,30 @@ class BadBill
     # @return [Resource] New resource with id and data set.
     def self.create params
       res = post(resource_name, {resource_name_singular => params})
+      return res if res.error
+
       res_data = res.__send__(resource_name_singular)
-      new res_data.id, res_data
+      new res_data.id.to_i, res_data
     end
 
     # Save any changed data.
     #
-    # @return [Boolean] True if successfull, false otherwise.
+    # @return [Resource] The instance with changed values or the error object.
     def save
-      @data.id = id
-      resp = put resource_name, id, {resource_name_singular => @data}
-      !resp
+      # Only save
+      if @__mutated__ && !@__mutated__.empty?
+        data = Hash[@__mutated__.map { |k| [k, @data[k]] }]
+
+        res = put resource_name, id, {resource_name_singular => data}
+
+        return res if res.error
+
+        res_data = res.__send__(resource_name_singular)
+        @data.merge!(res_data)
+        @__mutated__.clear
+      end
+
+      self
     end
 
     # Delete this resource.
@@ -85,6 +119,14 @@ class BadBill
       raise NoMethodError, "undefined method `id=' for '#{self.inspect.sub(/ .+/, '>')}`"
     end
 
+    def error
+      if @data.respond_to?(:error)
+        @data.error
+      else
+        nil
+      end
+    end
+
     private
 
     def resource_name_singular
@@ -102,7 +144,7 @@ class BadBill
     #
     # @return [String] The singular resource name.
     def self.resource_name_singular
-      @resource_name_singular ||= self.name.split(/::/).last.downcase
+      @resource_name_singular ||= self.name.split(/::/).last.split(/^|([A-Z][a-z]+)/).join('-').downcase
     end
 
     # The resource name (plural) for use with the API.