billogram 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 66bc9d6fc1707cc2615a8aa63e3fdd211e68ca4f
-  data.tar.gz: 8ad753d1c3b129104bb8c0557e4f92251e264e7d
+  metadata.gz: 018140ce51586895b8b6126ac450537e8591d5dd
+  data.tar.gz: a96d6e9e69756df541e6120ae4c5624a3ebd46b5
 SHA512:
-  metadata.gz: 829e2453b693f4e409f6d5374656e7ead261a505e21ae6a68d3efffe15c145964bb1ba9959aec4b855f9ffcb8b06042da8e341f1e4fa3962b97fd6197f4ebf40
-  data.tar.gz: 45e1132b2af23d470cdb4c0cc94e125bda47142d6ed4e1a89d66900d8a9a183ce9f0046f60375d6b8d3a17b7eab00a4c8b1cca7bec5eb4d74dc7072e55a45121
+  metadata.gz: 33c07c2eb69403500864bab82c19cf2163aae70d03df52a355f0be39bf08117dcd2c38ff32a610702c5dd894e136315fd18410f3c22b4317051108cc2f39d6b2
+  data.tar.gz: 490ac7762d7a05fb1b4271eb8bb545d6ccdde426b0494611d43dc6e1b6c39a43ed91e71db9a0913c29f03f0e171d257ce90525eb04ee8a379ce18db8bbd16fdd

data/README.md

@@ -1,8 +1,6 @@
 # Billogram
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/billogram`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Simple ruby wrapper for [Billogram](https://billogram.com) API
 
 ## Installation
 
@@ -22,7 +20,32 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+First you need to configure the client
+
+```ruby
+Billogram.configure do |config|
+  config.username = "6402-qz0UHqRJ"
+  config.password = "55e041056840d54dc8274f70c0a4170f"
+end
+```
+
+Add this code to `config/initializers/billogram.rb` if you're using Rails and don't forget to restart the server.
+
+Next step is to actually make API calls. Dead simple.
+
+## Resources
+
+We have 7 endpoints each represented by a class: `Invoice`, `Item`, `Customer`, `Event`, `Settings`, `Report`, `Logotype`
+
+Most of them support create, fetch, update actions as well as [search](https://billogram.com/api/documentation#object_search_parameters).
+
+Also there are nested resources (Address for instance), you cannot get them directly but only through the resource they belong.
+
+```ruby
+  Billogram::Address.search()               # =>  undefined method `search' for Billogram::Address:Class
+  customer = Billogram::Customer.fetch(32)
+  customer.address                          # => #<Billogram::Address:0x007f9aebafd358>
+````
 
 ## Development
 
@@ -38,4 +61,3 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERN
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/billogram.gemspec

@@ -23,8 +23,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "rspec-its"
+  spec.add_development_dependency "rspec", "~> 3.3"
   spec.add_development_dependency "webmock", "~> 1.21"
   spec.add_development_dependency "dotenv", "~> 2.0"
   spec.add_dependency "httparty", "~> 0.13"

data/lib/billogram.rb

@@ -31,7 +31,10 @@ require "billogram/version"
 
 module Billogram
   class << self
-    attr_accessor :username, :password, :base_uri
+    BASE_URI = "https://billogram.com/api/v2/"
+
+    attr_accessor :username, :password
+    attr_writer :base_uri
 
     def client
       @client ||= Client.new(username, password, base_uri)
@@ -40,5 +43,9 @@ module Billogram
     def configure
       yield self if block_given?
     end
+
+    def base_uri
+      @base_uri ||= BASE_URI
+    end
   end
 end

data/lib/billogram/client.rb

@@ -1,32 +1,15 @@
 module Billogram
   class Client
     include HTTParty
-    format :json
 
-    def initialize(username, password, base_uri)
-      self.class.default_options.merge!(base_uri: base_uri, basic_auth: {username: username, password: password})
-    end
+    extend Forwardable
 
-    def get(*args)
-      handle_request(:get, *args)
-    end
-
-    def post(*args)
-      handle_request(:post, *args)
-    end
+    delegate [:get, :post, :put, :delete] => self
 
-    def put(*args)
-      handle_request(:put, *args)
-    end
-
-    def delete(*args)
-      handle_request(:delete, *args)
-    end
+    format :json
 
-    def handle_request(method, *args)
-      response = self.class.send(method, *args)
-      return response.parsed_response["data"] if response.success?
-      raise Billogram::Error.from_response(response)
+    def initialize(username, password, base_uri)
+      self.class.default_options.merge!(base_uri: base_uri, basic_auth: {username: username, password: password})
     end
   end
 end

data/lib/billogram/endpoint.rb

@@ -10,10 +10,6 @@ module Billogram
         self.class.perform_request(:put, "#{endpoint}/#{id}", attributes)
       end
 
-      def delete
-        self.class.perform_request(:delete, "#{endpoint}/#{id}")
-      end
-
       def endpoint
         self.class.endpoint
       end

data/lib/billogram/error.rb

@@ -7,16 +7,21 @@ module Billogram
     class NotFound < Error; end
     class InternalServerError < Error; end
 
-    def self.from_response(response)
-      if klass =  case response.code.to_i
-                  when 400      then BadRequest
-                  when 401      then Unauthorized
-                  when 403      then Forbidden
-                  when 404      then NotFound
-                  when 500      then InternalServerError
-                  else               Billogram::Error
-                  end
-        klass.new(response["data"]["message"])
+    class << self
+      def from_response(response)
+        message = response["data"]["message"]
+        error_class(response).new(message)
+      end
+
+      def error_class(response)
+        case response.code.to_i
+        when 400  then BadRequest
+        when 401  then Unauthorized
+        when 403  then Forbidden
+        when 404  then NotFound
+        when 500  then InternalServerError
+        else           Billogram::Error
+        end
       end
     end
   end

data/lib/billogram/request.rb

@@ -20,7 +20,15 @@ module Billogram
     end
 
     def execute
-      Billogram.client.send(type, url, content)
+      response.success? ? response["data"] : raise_from(response)
+    end
+
+    def raise_from(response)
+      raise Billogram::Error.from_response(response)
+    end
+
+    def response
+      @response ||= Billogram.client.send(type, url, content)
     end
   end
 end

data/lib/billogram/resource.rb

@@ -30,10 +30,23 @@ module Billogram
     end
 
     def to_json(*args)
+      to_hash.to_json(*args)
+    end
+
+    def to_hash
       instance_variables
-        .map{|var| ["#{var}"[1..-1], instance_variable_get(var)]}
-        .to_h
-        .to_json(*args)
+        .each_with_object({}) do |variable, obj|
+          value = instance_variable_get(variable)
+
+          case value
+          when Resource
+            value = value.to_hash
+          when Array
+            value = value.map(&:to_hash)
+          end
+
+          obj[variable[1..-1]] = value
+        end
     end
   end
 end

data/lib/billogram/resources/invoice.rb

@@ -19,6 +19,7 @@ module Billogram
 
     relation :items, :many
     relation :events, :many
+    relation :automatic_reminders_settings, :many, class_override: 'AutomaticReminder'
 
     COMMANDS = [ :sell, :remind, :collect, :writeoff, :resend, :remind, :payment, :credit, :message, :attach ]
 

data/lib/billogram/resources/item.rb

@@ -9,5 +9,9 @@ module Billogram
 
     relation :bookkeeping, :one
     relation :regional_sweden, :one
+
+    def delete
+      self.class.perform_request(:delete, "#{endpoint}/#{id}")
+    end
   end
 end

data/lib/billogram/resources/settings.rb

@@ -4,11 +4,11 @@ module Billogram
 
     attr_accessor :name, :org_no
 
-    relation :contact, :one
-    relation :address, :one
-    relation :payment, :one
-    relation :tax, :one
-    relation :bookkeeping, :one
-    relation :invoices, :one, class_override: "InvoiceDefaults"
+    relation :tax,          :one
+    relation :contact,      :one
+    relation :address,      :one
+    relation :payment,      :one
+    relation :invoices,     :one, class_override: "InvoiceDefaults"
+    relation :bookkeeping,  :one
   end
 end

data/lib/billogram/version.rb

@@ -1,3 +1,3 @@
 module Billogram
-  VERSION = "0.4.2"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: billogram
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Mark Birman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-09-07 00:00:00.000000000 Z
+date: 2015-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -44,28 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: rspec-its
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.3'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement