billogram 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 01b1c1e7b6c92ecce8df12e6677b5e21c1e20a57
+  data.tar.gz: e2d5a6d94146f3668670cf17a80fda2de712b03f
+SHA512:
+  metadata.gz: 6ab92336c7e385b5797b67a2b9550da4f871d1fb0f61426a27bfc3bc98d102519517a42c9ba4235bc4afce6fdc54f5be33f6efbaa8d883af800d20dfc5d20301
+  data.tar.gz: 171be03c425b66915032ee90d8bf85687e2e575f394dc24d02618a1514dae4ca7b0539d349be79734435ebb1681aa093e6cd8b0427c182027684012dcfa0e2d8

data/.gitignore

@@ -0,0 +1,17 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.ruby-gemset
+.ruby-version
+test/fixtures

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in billogram.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Mark
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,25 @@
+# Billogram
+
+A tiny Ruby wrapper for Billogram API.
+
+## Installation
+    $ gem install billogram
+
+## Configuration
+    Billogram.configure do |c|
+      c.api_user = '6302-nibH3Grm'
+      c.api_key = 'e4d1bf5fba2f6e9df97a636dd8c67d2f'
+      c.base_url = 'https://sandbox.billogram.com/api/v2'
+    end
+
+## Usage
+    # Get an invoice by ID
+    @billgoram = Billogram::Invoice.get('gQjEEZL')
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/billogram/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+ 
+require 'rake/testtask'
+Rake::TestTask.new do |test|
+  test.libs << 'lib' << 'test'
+  test.ruby_opts << "-rubygems"
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end

data/billogram.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'billogram/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "billogram"
+  spec.version       = Billogram::VERSION
+  spec.authors       = ["Mark Birman"]
+  spec.email         = ["birmanmark@gmail.com"]
+  spec.summary       = %q{Ruby wrapper over Billogram API}
+  spec.description   = %q{Ruby wrapper over Billogram API}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "fakeweb", ["~> 1.3"]
+
+  spec.add_dependency "httparty"
+  spec.add_dependency "json"
+  spec.add_dependency "hashie"
+end

data/lib/billogram.rb

@@ -0,0 +1,24 @@
+require "httparty"
+require "hashie/mash"
+require "forwardable"
+
+Dir[File.dirname(__FILE__) + '/billogram/**/**.rb'].each do |file|
+  require file
+end
+
+module Billogram
+  CONFIG_KEYS = [:api_key, :api_user, :base_url].freeze
+
+  class << self
+    attr_accessor *CONFIG_KEYS
+
+    def configure
+      yield self
+      self
+    end
+
+    def client
+      @client ||= Client.new(api_user, api_key, base_url)
+    end
+  end
+end

data/lib/billogram/client.rb

@@ -0,0 +1,22 @@
+module Billogram
+  # https://github.com/lendai/billogram-api-clients/tree/master/ruby
+  class Client
+    include HTTParty
+    extend Forwardable
+
+    HEADERS =  {
+                  "Accept" => "application/json",
+                  "Content-Type" => "application/json"
+                }
+
+    headers HEADERS
+    format :json
+
+    delegate [:get, :post, :put, :delete] => self
+
+    def initialize(username, password, base_uri = Billogram.base_url)
+      self.class.base_uri base_uri
+      self.class.basic_auth username, password
+    end
+  end
+end

data/lib/billogram/resource.rb

@@ -0,0 +1,61 @@
+module Billogram
+  class Resource
+    class << self
+      attr_writer :endpoint
+
+      def endpoint
+        @endpoint || downcased_class_name
+      end
+
+      def get(id = '')
+        get_and_return_new("/#{endpoint}/#{id}")
+      end
+
+      private
+
+      def downcased_class_name
+        name.split('::').last.downcase
+      end
+
+      def get_and_return_new(url)
+        response = Billogram.client.get(url)
+        new response['data']
+      end
+    end
+
+    attr_reader :attributes
+
+    def initialize(attributes = {})
+      @attributes = Hashie::Mash.new(attributes)
+    end
+
+    def update(attributes = {})
+      Billogram.client.put("/#{endpoint}/#{id}", attributes)
+    end
+
+    def delete
+      Billogram.client.delete("/#{endpoint}/#{id}")
+    end
+
+    private
+
+    def method_missing(method, *args)
+      method_name = method.to_s
+
+      if method_name =~ /(=|\?)$/
+        case $1
+        when '='
+          attributes[$`] = args.first
+        when '?'
+          attributes[$`]
+        end
+      else
+        if attributes.respond_to?(method)
+          attributes[method]
+        else
+          super
+        end
+      end
+    end
+  end
+end

data/lib/billogram/resources/invoice.rb

@@ -0,0 +1,6 @@
+module Billogram
+  # https://billogram.com/api/documentation#billogram
+  class Invoice < Resource
+    self.endpoint = 'billogram'
+  end
+end

data/lib/billogram/version.rb

@@ -0,0 +1,3 @@
+module Billogram
+  VERSION = "0.0.1"
+end

data/test/billogram_test.rb

@@ -0,0 +1,26 @@
+require 'test_helper'
+
+describe Billogram do
+  Billogram::CONFIG_KEYS.each do |method|
+    it "should respond to #{method}" do
+      Billogram.must_respond_to method
+    end
+  end
+
+  describe '.configure' do
+    it 'should set values' do
+      Billogram.configure do |config|
+        Billogram::CONFIG_KEYS.each do |method|
+          config.send("#{method}=", method.to_s)
+          Billogram.send(method).must_equal method.to_s
+        end
+      end
+    end
+  end
+
+  describe '.client' do
+    it 'should be instance of Billogram::Client' do
+      Billogram.client.must_be_kind_of Billogram::Client
+    end
+  end
+end

data/test/fakeweb_helper.rb

@@ -0,0 +1,31 @@
+require 'fakeweb'
+
+def stub_file(stub)
+  File.join(File.dirname(__FILE__), 'stubs', stub)
+end
+
+def fake_it_all
+  FakeWeb.clean_registry
+
+  {
+    # GET URLs
+    :get => {
+      %r{https://\w+:\w+@billogram.com/api/v2/billogram/$}     => File.join('invoice', 'index'),
+      %r{https://\w+:\w+@billogram.com/api/v2/billogram/\w+}  => File.join('invoice', 'show')
+    },
+    # POST URLs
+    :post => {
+      'https://billogram.com/api/v2/billogram'            => File.join('invoice', 'create'),
+      %r{https://billogram.com/api/v2/\w+/command/send}   => File.join('invoice', 'send')
+    },
+    # PUT URLs
+    :put => {
+      %r{https://billogram.com/api/v2/\w+}                => File.join('invoice', 'update')
+    }
+  }.
+  each do |method, requests|
+    requests.each do |url, response|
+      FakeWeb.register_uri(method, url, :response => stub_file(response))
+    end
+  end
+end

data/test/resource_test.rb

@@ -0,0 +1,32 @@
+require 'test_helper'
+
+describe Billogram::Resource do
+  describe '.endpoint' do
+    it 'should set value' do
+      Billogram::Resource.endpoint = 'test_endpoint'
+      Billogram::Resource.endpoint.must_equal 'test_endpoint'
+    end
+
+    it 'should return downcased class name by default' do
+      Billogram::Resource.endpoint = nil
+      Billogram::Resource.endpoint.must_equal 'resource'
+    end
+  end
+
+  describe '.new' do
+    it 'should set attributes' do
+      resource = Billogram::Resource.new({string_attribute: 'test', zero_attribute: 0, integer_attribute: 2, false_attribute: false, nil_attribute: nil})
+      resource.string_attribute.must_equal 'test'
+      resource.zero_attribute.must_equal 0
+      resource.integer_attribute.must_equal 2
+      resource.false_attribute.must_equal false
+      resource.nil_attribute.must_equal nil
+    end
+  end
+
+  it 'should have setters for attributes' do
+    resource = Billogram::Resource.new({first: 'test'})
+    resource.first = 'first'
+    resource.first.must_equal 'first'
+  end
+end

data/test/resources/invoice_test.rb

@@ -0,0 +1,17 @@
+require 'test_helper'
+
+describe Billogram::Invoice do
+  before(:each) do
+    configure_billogram
+    fake_it_all
+    @billogram = Billogram::Invoice.get('gQjEEZL')
+  end
+
+  it 'should return an instance of Billogram::Invoice' do
+    @billogram.must_be_kind_of Billogram::Invoice
+  end
+
+  it 'should return id' do
+    @billogram.id.must_equal 'gQjEEZL'
+  end
+end

data/test/stubs/errors/403

@@ -0,0 +1,9 @@
+HTTP/1.1 403 FORBIDDEN
+Content-Type: application/json
+
+{
+  "status" : "INVALID_AUTH",
+  "data" : {
+    "message" : "Invalid username or password"
+  }
+}

data/test/stubs/errors/404

@@ -0,0 +1,9 @@
+HTTP/1.1 404 NOT FOUND
+Content-Type: application/json
+
+{
+  "status" : "NOT_FOUND",
+  "data" : {
+    "message" : "no billogram with id=DHjsdkO was found"
+  }
+}

data/test/stubs/invoice/index

@@ -0,0 +1,54 @@
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+  "status":"OK",
+  "meta":{
+    "total_count":171,
+    "total_remaining_sum":"159145.00"
+  },
+  "data":[
+    {
+      "customer":{
+        "name":"Happy customer",
+        "email":null,
+        "org_no":null,
+        "customer_no":5
+      },
+      "due_date":"2014-11-01",
+      "total_sum":3148.0,
+      "created_at":"2014-10-19 21:32:12",
+      "invoice_date":"2014-10-17",
+      "updated_at":"2014-10-19 21:32:12",
+      "currency":"SEK",
+      "state":"Unattested",
+      "remaining_sum":3148.0,
+      "flags":[
+      ],
+      "ocr_number":null,
+      "invoice_no":null,
+      "id":"u9PQW3E"
+    },
+    {
+      "customer":{
+        "name":"Systembolaget",
+        "email":"invoice@systembolaget.se",
+        "org_no":"",
+        "customer_no":1
+      },
+      "due_date":"2014-10-15",
+      "total_sum":72269.0,
+      "created_at":"2014-09-15 00:55:22",
+      "invoice_date":"2014-09-15",
+      "updated_at":"2014-09-15 01:07:19",
+      "currency":"SEK",
+      "state":"Unattested",
+      "remaining_sum":72269.0,
+      "flags":[
+      ],
+      "ocr_number":null,
+      "invoice_no":null,
+      "id":"EjWs4CP"
+    }
+  ]
+}

data/test/stubs/invoice/show

@@ -0,0 +1,125 @@
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+  "status":"OK",
+  "data":{
+    "due_days":15,
+    "info":{
+      "reference_number":null,
+      "our_reference":"John Doe",
+      "order_no":"AIB033",
+      "shipping_date":"2014-10-30",
+      "order_date":"2014-10-24",
+      "message":"Thank you!",
+      "delivery_date":"2014-10-30",
+      "your_reference":""
+    },
+    "attested_at":"2014-10-24 07:30:45",
+    "updated_at":"2015-01-23 23:44:17",
+    "currency":"SEK",
+    "detailed_sums":{
+      "credited_sum":0,
+      "net_sum":445,
+      "gross_sum":556.25,
+      "invoice_fee_vat":0,
+      "paid_sum":0,
+      "interest_fee":0,
+      "vat_sum":111.25,
+      "reminder_fee":0,
+      "invoice_fee":0,
+      "rounding":-0.25,
+      "regional_sweden":{
+        "rotavdrag_sum":0
+      },
+      "collector_paid_sum":0,
+      "remaining_sum":556
+    },
+    "id":"gQjEEZL",
+    "reminder_fee":"50",
+    "interest_rate":8.5,
+    "state":"Overdue",
+    "attachment":null,
+    "automatic_reminders":false,
+    "rounding_value":-0.25,
+    "ocr_number":"6409920018890569",
+    "events":[
+      {
+        "type":"BillogramCreated",
+        "created_at":"2014-10-24 07:30:42",
+        "data":null
+      },
+      {
+        "type":"BillogramSent",
+        "created_at":"2014-10-24 07:30:45",
+        "data":{
+          "letter_id":"Tk5NTQzQxNjQ14bccc9e8c0YTAwMjRmMGM3NANc8131024c90a0d24b1fc73",
+          "total_sum":556,
+          "scanning_central":null,
+          "remaining_sum":556,
+          "delivery_method":"Letter",
+          "invoice_no":190
+        }
+      },
+      {
+        "type":"Overdue",
+        "created_at":"2014-11-08 23:00:00",
+        "data":{
+          "remaining_sum":"556.00"
+        }
+      }
+    ],
+    "due_date":"2014-11-08",
+    "invoice_fee_vat":0,
+    "invoice_date":"2014-10-24",
+    "reminder_count":0,
+    "interest_fee":0.0,
+    "invoice_no":190,
+    "customer":{
+      "name":"Cool Customer",
+      "vat_no":null,
+      "phone":"+46 40 44 65 787",
+      "customer_no":3,
+      "address":{
+        "city":"",
+        "country":"SE",
+        "attention":"",
+        "zipcode":"62156",
+        "careof":"",
+        "street_address":"Schweitzergr\u00e4nd 10A"
+      },
+      "email":null,
+      "org_no":null
+    },
+    "invoice_fee":0,
+    "url":"https://billogram.com/r/2001905699988640/N9PCC4",
+    "items":[
+      {
+        "count":5.0,
+        "item_no":"110-1",
+        "description":"75cl Bigger Lager 7,5% - Imperial Pilsner - All In Brewing/Toccalmatto",
+        "title":"Bigger Lager 7,5% 75cl",
+        "regional_sweden":{
+          "rotavdrag":false
+        },
+        "price":89.0,
+        "discount":0.0,
+        "unit":"unit",
+        "vat":25
+      }
+    ],
+    "created_at":"2014-10-24 07:30:42",
+    "total_sum":556.0,
+    "delivery_method":"Letter",
+    "remaining_sum":556.0,
+    "flags":[
+
+    ],
+    "regional_sweden":{
+      "rotavdrag_personal_number":null,
+      "rotavdrag":0,
+      "reversed_vat":null,
+      "rotavdrag_description":null
+    }
+  }
+}

data/test/test_helper.rb

@@ -0,0 +1,14 @@
+require './lib/billogram'
+require 'minitest/autorun'
+require 'minitest/spec'
+require 'fakeweb_helper.rb'
+
+FakeWeb.allow_net_connect = false
+
+def configure_billogram
+  Billogram.configure do |config|
+    config.base_url = 'https://billogram.com/api/v2/'
+    config.api_user = 'username'
+    config.api_key = 'password'
+  end
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: billogram
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Mark Birman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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'
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby wrapper over Billogram API
+email:
+- birmanmark@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- billogram.gemspec
+- lib/billogram.rb
+- lib/billogram/client.rb
+- lib/billogram/resource.rb
+- lib/billogram/resources/invoice.rb
+- lib/billogram/version.rb
+- test/billogram_test.rb
+- test/fakeweb_helper.rb
+- test/resource_test.rb
+- test/resources/invoice_test.rb
+- test/stubs/errors/403
+- test/stubs/errors/404
+- test/stubs/invoice/index
+- test/stubs/invoice/show
+- test/test_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper over Billogram API
+test_files:
+- test/billogram_test.rb
+- test/fakeweb_helper.rb
+- test/resource_test.rb
+- test/resources/invoice_test.rb
+- test/stubs/errors/403
+- test/stubs/errors/404
+- test/stubs/invoice/index
+- test/stubs/invoice/show
+- test/test_helper.rb