freemle-client 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1139b760f58e0601e519d18c248b68b3df74b542
+  data.tar.gz: a220215243170d854787238ff73542ce058cbaf2
+SHA512:
+  metadata.gz: abc7703aa8921e96a5b9c82d47aa0dee09942b29973c1ebcb0b7fabd275930ead1cbca3b78f2d2d197cb88b9d2a5cf5d7d6707cccfa6bef57814ab1532679277
+  data.tar.gz: 4142ea8746a7031b13a786d6801ff9a94acf4e86c4d887071bf3c263c9a298a59575a1448897f34314012645e53078850ea4ac3bb5bee49f9c8217f5edbf4d6f

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Bob Forma
+
+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,11 @@
+# Freemle REST API client
+
+Usage:
+
+```
+Freemle::Client.base_url = "https://www.freemle.com/api"
+Freemle::Client.app_name = "your_application_name"
+Freemle::Client.api_key = "your_api_key"
+```
+
+Check https://www.freemle.com/api-documentatie for more info.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/freemle-client.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'freemle/client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "freemle-client"
+  spec.version       = Freemle::Client::VERSION
+  spec.authors       = ["Bob Forma"]
+  spec.email         = ["bforma@zilverline.com"]
+  spec.summary       = %q{Freemle.com REST API client}
+  spec.homepage      = "https://www.freemle.com/api-documentatie"
+  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.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "webmock"
+
+  spec.add_dependency "activesupport"
+  spec.add_dependency "httpclient"
+end

data/lib/freemle/client.rb

@@ -0,0 +1,115 @@
+require "freemle/client/version"
+require "active_support/all"
+require "httpclient"
+
+module Freemle
+  class Client
+    class << self
+      attr_accessor :base_url, :app_name, :api_key
+    end
+
+    # Finds customers in Freemle and returns them as a list of hashes. Each hash represents a customer.
+    #
+    # Raises Freemle::BadRequest when validation errors occur.
+    # Raises Freemle::UnauthorizedError when app_name and api_key are not properly set.
+    # Raises Freemle::ServerError if something goes wrong on the server for any other reason.
+    def self.find_customers(company_name)
+      client = get_client
+      response = client.get "#{base_url}/customers", {company_name: company_name}, {Authorization: "Basic #{get_auth_header}"}
+      handle_response(response, {200 => lambda { |response| from_json(response.body)["customers"] }})
+    end
+
+    # Creates an invoice in Freemle with the given values. Returns the unique ID of the created invoice.
+    #
+    # Raises Freemle::BadRequest when validation errors occur.
+    # Raises Freemle::UnauthorizedError when app_name and api_key are not properly set.
+    # Raises Freemle::ServerError if something goes wrong on the server for any other reason.
+    def self.create_invoice(invoice)
+      post "/invoices", invoice: invoice do |body_as_hash|
+        body_as_hash["invoice_id"]
+      end
+    end
+
+    # Creates a customer in Freemle with the given values. Returns the unique ID of the created invoice.
+    #
+    # Raises Freemle::BadRequest when validation errors occur.
+    # Raises Freemle::UnauthorizedError when app_name and api_key are not properly set.
+    # Raises Freemle::ServerError if something goes wrong on the server for any other reason.
+    def self.create_customer(customer)
+      post "/customers", customer: customer do |body_as_hash|
+        body_as_hash["customer_id"]
+      end
+    end
+
+  private
+
+    def self.post(url, body, &block)
+      client = get_client
+      response = client.post "#{base_url}#{url}", body.to_json, {Authorization: "Basic #{get_auth_header}", 'Content-Type' => 'application/json'}
+      body_as_hash = handle_response(response, {201 => lambda { |response| from_json(response.body) }})
+      yield body_as_hash
+    end
+
+    def self.get_client
+      HTTPClient.new
+    end
+
+    def self.get_auth_header
+      Base64.encode64("#{app_name}:#{api_key}").delete("\r\n")
+    end
+
+    def self.handle_response(response, status_handlers = {})
+      case response.status
+        when 400 then
+          raise BadRequest.new(from_json(response.body)["errors"])
+        when 401 then
+          raise UnauthorizedError
+        when 500 then
+          raise ServerError
+        else
+          if status_handlers[response.status].present?
+            status_handlers[response.status].call(response)
+          else
+            raise UnsupportedStatusCode.new(response.status)
+          end
+      end
+    end
+
+    def self.from_json(body)
+      ActiveSupport::JSON.decode(body)
+    end
+
+    class Error < RuntimeError
+    end
+
+    class UnsupportedStatusCode < Error
+      attr_reader :status_code
+
+      def initialize(status_code)
+        @status_code = status_code
+      end
+
+      def to_s
+        @status_code.to_s
+      end
+    end
+
+    class UnauthorizedError < Error
+    end
+
+    class ServerError < Error
+    end
+
+    class BadRequest < Error
+      attr_reader :errors
+
+      def initialize(errors)
+        @errors = errors
+      end
+
+      def to_s
+        @errors.to_s
+      end
+    end
+  end
+end

data/lib/freemle/client/version.rb

@@ -0,0 +1,5 @@
+module Freemle
+  class Client
+    VERSION = "0.0.1"
+  end
+end

data/spec/freemle/client_spec.rb

@@ -0,0 +1,93 @@
+require "spec_helper"
+
+describe Freemle::Client do
+
+  before do
+    Freemle::Client.base_url = "https://www.freemle.com/api"
+    Freemle::Client.app_name = "application"
+    Freemle::Client.api_key = "key"
+  end
+
+  describe "searching for customers" do
+    it "return empty list when no customers are found" do
+      stub_request(:get, /.*\/api\/customers\?company_name=foo/).
+        with(:headers => {'Authorization' => 'Basic YXBwbGljYXRpb246a2V5'}).
+        to_return(status: 200, body: {customers: []}.to_json)
+
+      actual = Freemle::Client.find_customers "foo"
+      actual.should == []
+    end
+
+    it "should return the customers as hashes" do
+      stub_request(:get, /.*\/api\/customers\?company_name=foo/).
+        with(:headers => {'Authorization' => 'Basic YXBwbGljYXRpb246a2V5'}).
+        to_return(status: 200, body: {customers: [{name: "foo"}, {name: "foobar"}]}.to_json)
+      actual = Freemle::Client.find_customers "foo"
+      actual.should == [{"name" => "foo"}, {"name" => "foobar"}]
+
+    end
+
+    it "should raise unauthorized when basic authentication fails" do
+      stub_request(:get, /.*\/api\/customers\?company_name=foo/).to_return(status: 401)
+      expect { Freemle::Client.find_customers("foo") }.to raise_error Freemle::Client::UnauthorizedError
+    end
+
+    it "should raise server error when 500 is returned" do
+      stub_request(:get, /.*\/api\/customers\?company_name=foo/).to_return(status: 500)
+      expect { Freemle::Client.find_customers("foo") }.to raise_error Freemle::Client::ServerError
+    end
+
+  end
+
+  describe "creating customers" do
+    before :each do
+      @customer = {name: "foo"}
+      @customer_id = "abc"
+    end
+
+    it "should return the id of the customer when successfully created" do
+      stub_request(:post, /.*\/api\/customers/).
+        with(headers: {'Authorization' => 'Basic YXBwbGljYXRpb246a2V5', 'Content-Type' => 'application/json'}, body: {customer: @customer}.to_json).
+        to_return(status: 201, body: {customer_id: @customer_id}.to_json)
+      actual = Freemle::Client.create_customer(@customer)
+      actual.should == @customer_id
+    end
+
+    it "should raise unauthorized when basic authentication fails" do
+      stub_request(:post, /.*\/api\/customers/).with(body: {customer: @customer}.to_json).to_return(status: 401)
+      expect { Freemle::Client.create_customer(@customer) }.to raise_error Freemle::Client::UnauthorizedError
+    end
+
+    it "should raise server error when 500 is returned" do
+      stub_request(:post, /.*\/api\/customers/).with(headers: {'Authorization' => 'Basic YXBwbGljYXRpb246a2V5', 'Content-Type' => 'application/json'}, body: {customer: @customer}.to_json).to_return(status: 500)
+      expect { Freemle::Client.create_customer(@customer) }.to raise_error Freemle::Client::ServerError
+    end
+  end
+
+  describe "creating invoices" do
+    before :each do
+      @invoice = {amount: 500}
+      @invoice_id = "cba"
+    end
+
+    it "should return the id of the invoice when successfully created" do
+      stub_request(:post, /.*\/api\/invoices/).
+        with(headers: {'Authorization' => 'Basic YXBwbGljYXRpb246a2V5', 'Content-Type' => 'application/json'}, body: {invoice: @invoice}.to_json).
+        to_return(status: 201, body: {invoice_id: @invoice_id}.to_json)
+      actual = Freemle::Client.create_invoice(@invoice)
+      actual.should == @invoice_id
+    end
+
+    it "should return list of errors when making a bad request" do
+      errors = {"invoice_date" => {"code" => "invalid"}}
+      stub_request(:post, /.*\/api\/invoices/).
+        with(headers: {'Authorization' => 'Basic YXBwbGljYXRpb246a2V5', 'Content-Type' => 'application/json'}, body: {invoice: @invoice}.to_json).
+        to_return(status: 400, body: {errors: errors}.to_json)
+      expect { Freemle::Client.create_invoice(@invoice) }.to raise_error { |error|
+        error.should be_a(Freemle::Client::BadRequest)
+        error.errors.should == errors
+      }
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require "rspec"
+require "webmock/rspec"
+require "freemle/client"

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: freemle-client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Bob Forma
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  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: webmock
+  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: activesupport
+  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: httpclient
+  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: 
+email:
+- bforma@zilverline.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- freemle-client.gemspec
+- lib/freemle/client.rb
+- lib/freemle/client/version.rb
+- spec/freemle/client_spec.rb
+- spec/spec_helper.rb
+homepage: https://www.freemle.com/api-documentatie
+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.0
+signing_key: 
+specification_version: 4
+summary: Freemle.com REST API client
+test_files:
+- spec/freemle/client_spec.rb
+- spec/spec_helper.rb