badbill 0.0.1

data/lib/badbill.rb

@@ -0,0 +1,152 @@
+# encoding: utf-8
+
+require 'yajl/json_gem'
+require 'faraday_middleware'
+require 'hashie/mash'
+
+require_relative 'badbill/resource'
+require_relative 'badbill/forward_methods'
+require_relative 'badbill/base_resource'
+
+require_relative 'badbill/client'
+require_relative 'badbill/invoice'
+
+# Handles the connection and requests to the Billomat API.
+#
+# This class can be used for direct API access and is used for connections from
+# resource classes.
+#
+# If a API resource is not yet implemented as a Ruby class, easy access is possible here.
+#
+# Examples:
+#
+#     billo = BadBill.new 'ruby', '1234568'
+#     # => #<BadBill:0x00000002825710     ...>
+#     billo.get 'clients'
+#     # => {"clients"=>{"client"=>[...]}}
+class BadBill
+  VERSION = '0.0.1'
+
+  # Reject any not allowed HTTP method.
+  class NotAllowedException < Exception; end
+  # Fail if no global connection is set.
+  class NoConnection < Exception; end
+
+  # The API url used for all connections.
+  API_URL = 'http%s://%s.billomat.net/'
+  # Allowed HTTP methods.
+  ALLOWED_METHODS = [:get, :post, :put, :delete]
+
+  # Create new Billomat connection.
+  #
+  # @param [String] billomat_id Used as your BillomatID
+  # @param [String] api_key     API Key used to authenticate to the API.
+  # @param [Boolean] ssl        Wether to use SSL or not (only possible for paying customers)
+  def initialize billomat_id, api_key, ssl=false
+    @billomat_id  = billomat_id
+    @api_key      = api_key
+    @ssl          = ssl
+    @http_adapter = connection
+
+    BadBill.connection = self
+  end
+
+  # Assign global BadBill connection object.
+  #
+  # @param [BadBill] connection The connection object.
+  def self.connection= connection
+    @connection = connection
+  end
+
+  # Get the global connection object.
+  #
+  # @return [BadBill, nil] The global connection object or nil if not set.
+  def self.connection
+    @connection
+  end
+
+  # Call the specified resource.
+  #
+  # It sets the X-BillomatApiKey header, the Content-Type header and the Accept header.
+  #
+  # @param [String] resource    The String resource name (gets prepended with _/api/_).
+  # @param [String,Integer] id  The ID for the resource.
+  # @param [Hash] options       All parameters for this request.
+  #                             Exact parameters depend on the resource.
+  # @param [Symbol] method      One of ALLOWED_METHODS.
+  #
+  # @return [Hashie::Mash] The response body.
+  #                        On error the return value only includes the key :error.
+  def call resource, id='', options=nil, method=:get
+    raise NotAllowedException.new("#{method.inspect} is not allowed. Use one of [:#{ALLOWED_METHODS*', :'}]") unless ALLOWED_METHODS.include?(method)
+
+    if id.kind_of? Hash
+      options = id
+      id = ''
+    end
+
+    #no_accept = options.delete :no_accept
+    @http_adapter.__send__(method) { |req|
+      if method == :get && options && !options.empty?
+        req.url "/api/#{resource}/#{id}", options
+      else
+        req.url "/api/#{resource}/#{id}"
+      end
+      req.headers['X-BillomatApiKey'] = @api_key
+      req.headers['Accept'] = 'application/json'
+      req.headers['Content-Type'] = 'application/json' if [:post, :put].include?(method)
+      req.body = options if method != :get && options && !options.empty?
+    }.body
+  rescue Faraday::Error::ClientError => error
+    Hashie::Mash.new :error => error
+  end
+
+  # Send a GET request.
+  #
+  # @param (see #call)
+  # @return (see #call)
+  def get resource, id='', options=nil
+    call resource, id, options, :get
+  end
+
+  # Send a POST request.
+  #
+  # @param (see #call)
+  # @return (see #call)
+  def post resource, id='', options=nil
+    call resource, id, options, :post
+  end
+
+  # Send a PUT request.
+  #
+  # @param (see #call)
+  # @return (see #call)
+  def put resource, id='', options=nil
+    call resource, id, options, :put
+  end
+
+  # Send a DELETE request.
+  #
+  # @param (see #call)
+  # @return (see #call)
+  def delete resource, id='', options=nil
+    call resource, id, options, :delete
+  end
+
+  private
+  # Creates a new Faraday connection object.
+  #
+  # @return [Faraday] new connection object with url and response handling set.
+  def connection
+    @connection ||= Faraday.new(API_URL % [@ssl ? 's' : '', @billomat_id]) do |conn|
+      conn.request :json
+
+      conn.response :mashify
+      conn.response :json, :content_type => /\bjson$/
+      #conn.response :logger
+      conn.response :raise_error
+      conn.adapter  :net_http
+      conn.options[:timeout] = 2
+    end
+  end
+end

data/spec/badbill/base_resource_spec.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+
+require_relative '../helper'
+
+describe BadBill::BaseResource do
+  it "can't set a new ID" do
+    b = BadBill::BaseResource.new 42, {}
+    b.id.should == 42
+    lambda{ b.id = 23 }.should raise_error(NoMethodError)
+    b.id.should == 42
+  end
+end

data/spec/badbill/client_spec.rb

@@ -0,0 +1,98 @@
+# encoding: utf-8
+
+require_relative '../helper'
+
+describe BadBill::Client do
+  before :all do
+    @badbill = BadBill.new "ruby", "12345"
+  end
+
+  it "fetches all clients" do
+    stub = stub_request(:get, "ruby.billomat.net/api/clients/").
+      with(:headers => {'Accept' => 'application/json'}).
+      to_return(:body => '{"clients":{"client":[{"id":1}]}}',
+               :headers => {'Content-Type' => 'application/json'})
+
+    resp = BadBill::Client.all
+    stub.should have_been_requested
+
+    resp.size.should == 1
+    resp.first.id.should == 1
+  end
+
+  it "fetches info about myself" do
+    stub = stub_request(:get, "ruby.billomat.net/api/clients/myself").
+      with(:headers => {'Accept' => 'application/json'}).
+      to_return(:body => '{"client":{"id":1}}',
+               :headers => {'Content-Type' => 'application/json'})
+
+    resp = BadBill::Client.myself
+    stub.should have_been_requested
+
+    resp.id.should == 1
+    resp.myself?.should == true
+  end
+
+  it "fetches info about another client" do
+    stub = stub_request(:get, "ruby.billomat.net/api/clients/1").
+      with(:headers => {'Accept' => 'application/json'}).
+      to_return(:body => '{"client":{"id":1}}',
+               :headers => {'Content-Type' => 'application/json'})
+
+    resp = BadBill::Client.find 1
+    stub.should have_been_requested
+
+    resp.id.should == 1
+    resp.myself?.should == false
+  end
+
+  it "saves changes to client data" do
+    body = { client: {name: "old name", "id" => 1} }
+    stub_request(:get, "ruby.billomat.net/api/clients/1").
+      with(:headers => {'Accept' => 'application/json'}).
+      to_return(:body => body,
+               :headers => {'Content-Type' => 'application/json'})
+
+    client = BadBill::Client.find 1
+
+    body = { client: {name: "new name", "id" => 1} }
+    stub = stub_request(:put, "ruby.billomat.net/api/clients/1").
+      with(:headers => {'Accept' => 'application/json'}, :body => body).
+      to_return(:status => 200)
+
+    client.name.should == "old name"
+    client.name = "new name"
+    client.save.should == true
+    stub.should have_been_requested
+  end
+
+  it "creates a new client with given data" do
+    body = {
+      "client" => {
+        "name"                 => "Musterfirma",
+        "salutation"           => "Herr",
+        "first_name"           => "Max",
+        "last_name"            => "Muster",
+        "street"               => "Musterstraße 123",
+        "zip"                  => "12345",
+        "city"                 => "Musterstadt",
+        "state"                => "Bundesland",
+        "country_code"         => "DE",
+      }
+    }
+
+    body_return = { "client" => body["client"].dup }
+    body_return["client"]["id"] = 42
+    body_return["client"]["created"] = "2007-12-13T12:12:00+01:00"
+
+    stub = stub_request(:post, "ruby.billomat.net/api/clients/").
+      with(:body => body.to_json, :headers => {'Accept' => 'application/json',
+        'Content-Type'=>'application/json'}).
+      to_return(:status => 201, :body => body_return,
+                :headers => {'Content-Type' => 'application/json'})
+
+    client = BadBill::Client.create body["client"]
+    stub.should have_been_requested
+    client.id.should == 42
+  end
+end

data/spec/badbill/invoice_spec.rb

@@ -0,0 +1,228 @@
+# encoding: utf-8
+
+require_relative '../helper'
+
+describe BadBill::Invoice do
+  before :all do
+    @badbill = BadBill.new "ruby", "12345"
+  end
+
+  it "fetches all invoices" do
+    stub = stub_request(:get, "ruby.billomat.net/api/invoices/").
+      with(:headers => {'Accept' => 'application/json'}).
+      to_return(:body => '{"invoices":{"invoice":[{"id":1}]}}',
+               :headers => {'Content-Type' => 'application/json'})
+
+    resp = BadBill::Invoice.all
+    stub.should have_been_requested
+
+    resp.size.should == 1
+    resp.first.id.should == 1
+  end
+
+  it "fetches info about an invoice" do
+    stub = stub_request(:get, "ruby.billomat.net/api/invoices/1").
+      with(:headers => {'Accept' => 'application/json'}).
+      to_return(:body => '{"invoice":{"id":1}}',
+               :headers => {'Content-Type' => 'application/json'})
+
+    resp = BadBill::Invoice.find 1
+    stub.should have_been_requested
+
+    resp.id.should == 1
+  end
+
+  context "existing invoice" do
+    before :each do
+      stub_request(:get, "ruby.billomat.net/api/invoices/1").
+        with(:headers => {'Accept' => 'application/json'}).
+        to_return(:body => '{"invoice":{"id":1,"status":"DRAFT"}}',
+                  :headers => {'Content-Type' => 'application/json'})
+
+      @invoice = BadBill::Invoice.find 1
+    end
+
+    it "marks invoice as complete" do
+      stub = stub_request(:put, "ruby.billomat.net/api/invoices/1/complete").
+        with(:headers => {'Accept' => 'application/json'}).
+        to_return(:status => 200)
+
+      @invoice.complete.should == true
+      stub.should have_been_requested
+    end
+
+    it "cancels an invoice" do
+      stub = stub_request(:put, "ruby.billomat.net/api/invoices/1/cancel").
+        with(:headers => {'Accept' => 'application/json'}).
+        to_return(:status => 200)
+
+      @invoice.cancel.should == true
+      stub.should have_been_requested
+    end
+
+    it "deletes an invoice" do
+      stub = stub_request(:delete, "ruby.billomat.net/api/invoices/1").
+        with(:headers => {'Accept' => 'application/json'}).
+        to_return(:status => 200)
+
+      @invoice.delete.should == true
+      stub.should have_been_requested
+    end
+
+    it "fetches the pdf" do
+      body = {
+        "pdf" => {
+         "id" => 1,
+          "created" => "2009-09-02T12 =>04 =>15+02 =>00",
+          "invoice_id" => 1,
+          "filename" => "invoice_1.pdf",
+          "mimetype" => "application/pdf",
+          "filesize" => "1",
+          "base64file" => "foobar"
+        }
+      }
+
+      stub = stub_request(:get, "ruby.billomat.net/api/invoices/1/pdf").
+        with(:headers => {'Accept' => 'application/json'}).
+        to_return(:body => body, :headers => {
+          'Content-Type' => 'application/json'
+        })
+
+      pdf = @invoice.pdf
+
+      stub.should have_been_requested
+      pdf.id.should == 1
+      pdf.invoice_id == 1
+    end
+
+    it "uploads a signature" do
+      body = {"signature" => {"base64file" => "cnVieQ==\n"}}
+      stub = stub_request(:put, "ruby.billomat.net/api/invoices/1/upload-signature").
+        with(:headers => {'Accept' => 'application/json'}, :body => body).
+        to_return(:status => 200)
+
+      @invoice.status = "OPEN"
+      file_content = StringIO.new "ruby"
+      resp = @invoice.upload_signature file_content
+      resp.should == true
+
+      stub.should have_been_requested
+    end
+
+    context "sending invoice as mail" do
+      it "sends an invoice via mail" do
+        body = {
+          "email" => {
+            "from" => "sender@test.example",
+            "recipients" => {
+              "to" => "recv@test.example",
+              "cc" => "mail@test.example"
+            },
+            "subject" => "subject",
+            "body" => "body",
+            "filename" => "invoice",
+            "attachments" => {
+              "attachment" => {
+                "filename" => "more.pdf",
+                "mimetype" => "application/pdf",
+                "base64file" => "foobar"
+              }
+            }
+          }
+        }
+
+        stub = stub_request(:post, "ruby.billomat.net/api/invoices/1/email").
+          with(:headers => {'Accept' => 'application/json'}, :body => body).
+          to_return(:headers => {
+          'Content-Type' => 'application/json'
+        })
+
+        resp = @invoice.email "recv@test.example", "sender@test.example",
+        "subject", "body", {
+          recipients: { cc: "mail@test.example" },
+          filename: "invoice",
+          attachments: {
+            attachment: {
+              filename: "more.pdf",
+              mimetype: "application/pdf",
+              base64file: "foobar"
+            }
+          }
+        }
+
+        stub.should have_been_requested
+        resp.should == true
+      end
+
+      it "sends an invoice with only basic information" do
+        body = {
+          "email" => {
+            "recipients" => {
+              "to" => "recv@test.example",
+              "cc" => "mail@test.example",
+            }
+          }
+        }
+
+        stub = stub_request(:post, "ruby.billomat.net/api/invoices/1/email").
+          with(:headers => {'Accept' => 'application/json'}, :body => body).
+          to_return(:headers => {
+          'Content-Type' => 'application/json'
+        })
+
+        resp = @invoice.email "recv@test.example", {recipients: { cc: "mail@test.example" }}
+
+        stub.should have_been_requested
+        resp.should == true
+      end
+
+      it "sends an invoice with basic information and from" do
+        body = {
+          "email" => {
+            "recipients" => {
+              "to" => "recv@test.example",
+              "cc" => "mail@test.example",
+            },
+            "from" => "sender@test.example"
+          }
+        }
+
+        stub = stub_request(:post, "ruby.billomat.net/api/invoices/1/email").
+          with(:headers => {'Accept' => 'application/json'}, :body => body).
+          to_return(:headers => {
+          'Content-Type' => 'application/json'
+        })
+
+        resp = @invoice.email "recv@test.example", "sender@test.example", {recipients: { cc: "mail@test.example" }}
+
+        stub.should have_been_requested
+        resp.should == true
+      end
+
+      it "sends an invoice with basic information, from and subject" do
+        body = {
+          "email" => {
+            "recipients" => {
+              "to" => "recv@test.example",
+              "cc" => "mail@test.example",
+            },
+            "from" => "sender@test.example",
+            "subject" => "subject"
+          }
+        }
+
+        stub = stub_request(:post, "ruby.billomat.net/api/invoices/1/email").
+          with(:headers => {'Accept' => 'application/json'}, :body => body).
+          to_return(:headers => {
+          'Content-Type' => 'application/json'
+        })
+
+        resp = @invoice.email "recv@test.example", "sender@test.example", "subject",
+          {recipients: { cc: "mail@test.example" }}
+
+        stub.should have_been_requested
+        resp.should == true
+      end
+    end
+  end
+end

data/spec/badbill_spec.rb

@@ -0,0 +1,89 @@
+# encoding: utf-8
+
+require_relative 'helper'
+
+describe BadBill do
+  it "creates new global connection object" do
+    BadBill.connection.should be_nil
+    b = BadBill.new "ruby", "12345"
+    BadBill.connection.should_not be_nil
+  end
+
+  context "sending requests" do
+    before :each do
+      @badbill = BadBill.new "ruby", "12345"
+    end
+
+    it "sends a specified request to the API" do
+      stub = stub_request(:get, "ruby.billomat.net/api/").
+        with(:headers => {'Accept' => /application\/json/}).
+        to_return(:body => "{}")
+
+      @badbill.call ''
+      stub.should have_been_requested
+    end
+
+    it "sends a GET request to the API" do
+      stub = stub_request(:get, "ruby.billomat.net/api/").
+        with(:headers => {'X-BillomatApiKey' => '12345',
+          'Accept' => /application\/json/}).
+        to_return(:body => "{}")
+
+      @badbill.get ''
+      stub.should have_been_requested
+    end
+
+    it "sends a GET request with parameters to the API" do
+      stub = stub_request(:get, "ruby.billomat.net/api/resource/?option=foobar").
+        with(:headers => {'X-BillomatApiKey' => '12345',
+          'Accept' => /application\/json/}).
+        to_return(:body => "{}")
+
+      @badbill.get 'resource', option: "foobar"
+      stub.should have_been_requested
+    end
+
+    it "sends a POST request to the API" do
+      stub = stub_request(:post, "ruby.billomat.net/api/").
+        with(:headers => {'X-BillomatApiKey' => '12345',
+          'Accept' => /application\/json/,
+          'Content-Type' => /application\/json/}).
+        to_return(:body => "{}")
+
+      @badbill.post ''
+      stub.should have_been_requested
+    end
+
+    it "sends a PUT request to the API" do
+      stub = stub_request(:put, "ruby.billomat.net/api/").
+        with(:headers => {'X-BillomatApiKey' => '12345',
+          'Accept' => /application\/json/,
+          'Content-Type' => /application\/json/}).
+        to_return(:body => "{}")
+
+      @badbill.put ''
+      stub.should have_been_requested
+    end
+
+    it "sends a DELETE request to the API" do
+      stub = stub_request(:delete, "ruby.billomat.net/api/").
+        with(:headers => {'X-BillomatApiKey' => '12345',
+          'Accept' => /application\/json/}).
+        to_return(:body => "{}")
+
+      @badbill.delete ''
+      stub.should have_been_requested
+    end
+
+    it "returns an error object on HTTP errors" do
+      stub = stub_request(:get, "ruby.billomat.net/api/resource/").
+        with(:headers => {'X-BillomatApiKey' => '12345',
+          'Accept' => /application\/json/}).
+        to_return(:status => 404)
+
+      resp = @badbill.get 'resource'
+      resp.error.kind_of?(Faraday::Error::ClientError).should == true
+      stub.should have_been_requested
+    end
+  end
+end

data/spec/helper.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+
+if ENV['COVERAGE']
+  require 'simplecov'
+
+  SimpleCov.formatter = Class.new do
+    def format(result)
+      SimpleCov::Formatter::HTMLFormatter.new.format(result) unless ENV['CI']
+      File.open('coverage/covered_percent', 'w') do |f|
+        f.puts result.source_files.covered_percent.to_i
+      end
+    end
+  end
+
+  SimpleCov.start
+end
+
+require 'rspec'
+require 'webmock/rspec'
+
+here = File.expand_path(File.dirname(__FILE__) + '/..')
+$LOAD_PATH.unshift here+'/lib'
+
+require 'badbill'