badbill 0.0.1 → 0.1.0

data/lib/badbill/client.rb

@@ -17,7 +17,7 @@ class BadBill
     # @return [Client] A new resource.
     def self.myself
       c = get 'clients', 'myself'
-      client = new c.client.id, c.client
+      client = new c.client.id.to_i, c.client
       client.myself = true
       client
     end

data/lib/badbill/faraday_gzip.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+
+require 'zlib'
+require 'faraday_middleware/response_middleware'
+
+module FaradayMiddleware
+  class Gzip < ResponseMiddleware
+    define_parser do |body|
+      Zlib::GzipReader.new(StringIO.new(body)).read
+    end
+
+    def parse_response?(env)
+      super && env[:response_headers]['content-encoding'] == "gzip"
+    end
+  end
+end
+
+Faraday::Response.register_middleware :gzip => FaradayMiddleware::Gzip

data/lib/badbill/forward_methods.rb

@@ -11,6 +11,12 @@ class BadBill
     # assignment request, we only check for the method name without the equal sign.
     def method_missing(method_name, *arguments, &block)
       if data.respond_to?(method_name.to_s.sub(/=$/, ''))
+        if method_name.to_s.end_with?('=')
+          @__mutated__ ||= []
+          @__mutated__ << method_name.to_s.sub(/=$/, '')
+          @__mutated__.uniq!
+        end
+
         data.send(method_name, *arguments, &block)
       else
         super

data/lib/badbill/invoice.rb

@@ -7,6 +7,34 @@ class BadBill
   #
   # See http://www.billomat.com/en/api/invoices
   class Invoice < BaseResource
+    # Get aggregated list of invoices.
+    #
+    # BE CAREFUL: The returned objects are not really invoices.
+    # See http://www.billomat.com/en/api/invoices/ for the format.
+    #
+    # @param [String,Symbol,#to_s] type One of ['client', 'status', 'day',
+    #                                   'week', 'month', 'year'].
+    #                                   Specify multiple types for finer
+    #                                   aggregation.
+    #
+    # @return [Array<Invoices>] All found resources.
+    def self.group_by *type
+      if type.respond_to?(:join)
+        type = type.join(',')
+      end
+
+      all = get resource_name, group_by: type
+
+      return all if all.error
+
+      data = all.__send__('invoice-groups').__send__('invoice-group')
+
+      if data.kind_of? Array
+        data
+      else
+        [data]
+      end
+    end
     # Get the PDF invoice.
     #
     #
@@ -16,7 +44,9 @@ class BadBill
     #                        all parameters.
     def pdf
       resp = get resource_name, "#{id}/pdf"
-      resp.pdf
+      ret = resp.pdf
+      ret.id = ret.id.to_i
+      ret
     end
 
     # Closes a statement in the draft status (DRAFT). Here, the

data/lib/badbill/invoice_comment.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+
+class BadBill
+  # The InvoiceComment resource handles all invoice comments.
+  #
+  # See http://www.billomat.com/en/api/invoices/comments-and-history/
+  class InvoiceComment < BaseResource
+    # Get all Invoice Comments for given invoice id.
+    #
+    # @param [Integer] invoice_id The invoice id to search for.
+    # @param [String,Array] actionkey Indicates what kind of comment it is. See API docu for possible values. An Array will be joined into a String.
+    #
+    # @return [Array<InvoiceComment>] All found invoice comments.
+    def self.all invoice_id, actionkey=nil
+      params = { invoice_id: invoice_id }
+      if actionkey
+        actionkey = actionkey.join(',') if actionkey.respond_to?(:join)
+        params[:actionkey] = actionkey
+      end
+
+      super params
+    end
+  end
+end

data/lib/badbill/invoice_item.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+
+class BadBill
+  # The InvoiceItem resource handles all invoice items.
+  #
+  # See http://www.billomat.com/en/api/invoices/items/
+  class InvoiceItem < BaseResource
+    # Get all resources of this type.
+    #
+    # @param [Integer] invoice_id The invoice id to search for.
+    #
+    # @return [Array<InvoiceItem>] All found invoice items.
+    def self.all invoice_id
+      super invoice_id: invoice_id
+    end
+  end
+end

data/lib/badbill/invoice_payment.rb

@@ -0,0 +1,28 @@
+# encoding: utf-8
+
+class BadBill
+  # The InvoicePayment resource handles all invoice payments.
+  #
+  # See http://www.billomat.com/en/api/invoices/payments/
+  class InvoicePayment < BaseResource
+    # Create a new invoice payment.
+    #
+    # @param [String,] invoice_id The ID of the invoice
+    # @param [String,Numeric] amount The paid amount
+    # @param [Boolean] is_paid Wether the invoice should be marked as paid
+    #                  or not
+    # @return [InvoicePayment,Hashie::Mash] New payment with id and data set
+    #                                       or hash if any error happened
+    def self.create invoice_id, amount, is_paid=false, params={}
+      params['invoice_id']           = invoice_id
+      params['amount']               = amount
+      params['mark_invoice_as_paid'] = is_paid
+
+      res = post(resource_name, {resource_name_singular => params})
+      return res if res.error
+
+      res_data = res.__send__(resource_name_singular)
+      new res_data.id.to_i, res_data
+    end
+  end
+end

data/lib/badbill/recurring.rb

@@ -0,0 +1,11 @@
+# encoding: utf-8
+
+require 'base64'
+
+class BadBill
+  # The Recurring resource handles all recurring invoices.
+  #
+  # See http://www.billomat.com/en/api/recurring
+  class Recurring < BaseResource
+  end
+end

data/spec/badbill/base_resource_spec.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 
-require_relative '../helper'
+require 'spec_helper'
 
 describe BadBill::BaseResource do
   it "can't set a new ID" do

data/spec/badbill/client_spec.rb

@@ -1,98 +1,102 @@
 # encoding: utf-8
 
-require_relative '../helper'
+require 'spec_helper'
 
 describe BadBill::Client do
   before :all do
-    @badbill = BadBill.new "ruby", "12345"
+    @badbill = new_badbill 1
   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'})
+    VCR.use_cassette('all_clients') do
+      resp = BadBill::Client.all
 
-    resp = BadBill::Client.all
-    stub.should have_been_requested
-
-    resp.size.should == 1
-    resp.first.id.should == 1
+      resp.size.should eq(1)
+      resp.first.id.should eq(169499)
+    end
   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
+    VCR.use_cassette('myself_client') do
+      resp = BadBill::Client.myself
 
-    resp.id.should == 1
-    resp.myself?.should == true
+      resp.id.should eq(148386)
+      resp.myself?.should be_true
+    end
   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'})
+    VCR.use_cassette('existent client') do
+      resp = BadBill::Client.find 169499
+
+      resp.id.should eq(169499)
+      resp.myself?.should be_false
+    end
+  end
 
-    resp = BadBill::Client.find 1
-    stub.should have_been_requested
+  it "returns nil when no client found" do
+    VCR.use_cassette('non existent client') do
+      resp = BadBill::Client.find 11111
 
-    resp.id.should == 1
-    resp.myself?.should == false
+      resp.should be_nil
+    end
   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
+    client = nil
+    VCR.use_cassette('existent client') do
+      client = BadBill::Client.find 169499
+    end
+
+    VCR.use_cassette('client on change') do
+      client.name.should eq("Jan-Erik Rediger")
+      client.name = "new name"
+      saved = client.save
+
+      saved.error.should be_nil
+      saved.name.should eq("new name")
+      client.name.should eq("new name")
+    end
+  end
+
+  it "returns error on failed save" do
+    VCR.use_cassette('save for non-existent client') do
+      client = BadBill::Client.new 169500, Hashie::Mash.new(name: "foo")
+      client.name = "new name"
+      saved = client.save
+
+      saved.error.should be_a(Faraday::Error::ClientError)
+    end
   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",
+    VCR.use_cassette('new client') do
+      data = {
+        "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"
+      client = BadBill::Client.create data
+      client.id.should_not be_nil
+      client.name.should eq("Musterfirma")
+    end
+  end
 
-    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'})
+  context "create with wrong data" do
+    it "returns an error" do
+      VCR.use_cassette('wrong data for client') do
+        data = { "email" => "this@is.invalid" }
+        client = BadBill::Client.create data
 
-    client = BadBill::Client.create body["client"]
-    stub.should have_been_requested
-    client.id.should == 42
+        client.error.should be_a(Faraday::Error::ClientError)
+      end
+    end
   end
 end

data/spec/badbill/invoice_comment_spec.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe BadBill::InvoiceComment do
+  before :all do
+    @badbill = new_badbill 1
+  end
+
+  it "fetches all invoice-comments" do
+    VCR.use_cassette("invoice-comments by invoice id") do
+      resp = BadBill::InvoiceComment.all 360264
+
+      resp.size.should eq(3)
+    end
+  end
+
+  it "fetches all invoice-comments for PAYED status" do
+    VCR.use_cassette("invoice-comments by invoice id and actionkey PAYMENT") do
+      resp = BadBill::InvoiceComment.all 360264, 'PAYMENT'
+
+      resp.size.should eq(1)
+    end
+  end
+
+  it "fetches all invoice-comments for 2 actionkey params" do
+    VCR.use_cassette("invoice-comments by invoice id and actionkeys") do
+      resp = BadBill::InvoiceComment.all 360264, ['CREATE','PAYMENT']
+
+      resp.size.should eq(2)
+    end
+  end
+end

data/spec/badbill/invoice_item_spec.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe BadBill::InvoiceItem do
+  before :all do
+    @badbill = new_badbill 1
+  end
+
+  it "fetches all invoice-item" do
+    VCR.use_cassette("fetches invoice-item by id") do
+      resp = BadBill::InvoiceItem.all 1
+
+      resp.size.should eq(0)
+    end
+  end
+end

data/spec/badbill/invoice_payment_spec.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe BadBill::InvoicePayment do
+  before :all do
+    @badbill = new_badbill 1
+  end
+
+  it "fetches all invoice-payments" do
+    VCR.use_cassette('invoice payments') do
+      resp = BadBill::InvoicePayment.all
+
+      resp.size.should eq(0)
+    end
+  end
+end

data/spec/badbill/invoice_spec.rb

@@ -1,227 +1,128 @@
 # encoding: utf-8
 
-require_relative '../helper'
+require 'spec_helper'
 
 describe BadBill::Invoice do
   before :all do
-    @badbill = BadBill.new "ruby", "12345"
+    @badbill = new_badbill 1
   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'})
+    VCR.use_cassette("all invoices") do
+      resp = BadBill::Invoice.all
 
-    resp = BadBill::Invoice.all
-    stub.should have_been_requested
-
-    resp.size.should == 1
-    resp.first.id.should == 1
+      resp.size.should eq(2)
+    end
   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'})
+    VCR.use_cassette("invoice info") do
+      resp = BadBill::Invoice.find 352709
+
+      resp.id.should eq(352709)
+      resp.invoice_number.to_i.should eq(1)
+    end
+  end
 
-    resp = BadBill::Invoice.find 1
-    stub.should have_been_requested
+  it "fetches aggregated invoices" do
+    VCR.use_cassette("aggregated invoices") do
+      resp = BadBill::Invoice.group_by :client
 
-    resp.id.should == 1
+      resp.first.total_gross.should == "124.00"
+    end
   end
 
-  context "existing invoice" do
+  context "existing invoice 1" 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
+      VCR.use_cassette('draft item') do
+        @invoice = BadBill::Invoice.find 352320
+      end
     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
+      VCR.use_cassette('invoice marked as complete') do
+        @invoice.complete.should == true
+      end
     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
+    it "cancels an invoice" do
+      VCR.use_cassette('invoice canceled') do
+        @invoice.cancel.should == true
+      end
     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
+      VCR.use_cassette('invoice deleted') do
+        @invoice.delete.should == true
+      end
     end
+  end
 
+  context "existing invoice 2" do
+    before :each do
+      VCR.use_cassette('invoice info') do
+        @invoice = BadBill::Invoice.find 352709
+      end
+    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
+      VCR.use_cassette('fetched invoice pdf') do
+        pdf = @invoice.pdf
+
+        pdf.id.should == 356105
+        pdf.invoice_id == 352709
+      end
     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
+      VCR.use_cassette('invoice uploaded signature') do
+        file_content = StringIO.new "ruby"
+        resp = @invoice.upload_signature file_content
+        resp.should == true
+      end
     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"
+        VCR.use_cassette('invoice send mail') do
+          resp = @invoice.email "M8R-10apg01@mailinator.com", "janerik@badbill.net",
+            "subject", "body", {
+              recipients: { cc: "f4a269895b2c7eccd43296d2b@mailinator.com" },
+              filename: "invoice",
+                attachments: {
+                  attachment: {
+                  filename: "more.pdf",
+                  mimetype: "application/pdf",
+                  base64file: "Zm9vYmFyCg=="
+                }
               }
             }
-          }
-        }
-
-        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
+          resp.should == true
+        end
       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
+        VCR.use_cassette('invoice send email with basic info') do
+          resp = @invoice.email "M8R-10apg01@mailinator.com", {recipients: { cc: "mail@test.example" }}
+          resp.should == true
+        end
       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
+        VCR.use_cassette('invoice send email with basic info and from') do
+          resp = @invoice.email "M8R-10apg01@mailinator.com", "sender@test.example", {recipients: { cc: "mail@test.example" }}
+          resp.should == true
+        end
       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
+        VCR.use_cassette('invoice send email with basic info from and subject') do
+          resp = @invoice.email "M8R-10apg01@mailinator.com", "sender@test.example", "subject",
+            {recipients: { cc: "mail@test.example" }}
+
+          resp.should == true
+        end
       end
     end
   end