freemle 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4e1013fba2d5336932c0827e8d014bce165a24f3
+  data.tar.gz: 79bfd250d6e893121d107ca72ca496e6ed1dfd1c
+SHA512:
+  metadata.gz: 04ff928ebaff86b4ebad56f803f761389c484fb0a6b4ca977c2c48f0bfb26a042fdbd28519be66281becea281b94dc22340ca1f5d8379a48d712070b34b58966
+  data.tar.gz: 45427f788741f31dd3bd32dcade47882a853a2bb0b5740d27161ad92e4e644415dceafbc10229e76dc243414ea7c839bfe71dbab28987d8620c62440585c1691

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/.ruby-version

@@ -0,0 +1 @@
+2.1.0

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.1.0

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,81 @@
+# Freemle REST API client
+
+[![Build Status](https://travis-ci.org/freemle/freemle-ruby.svg)](https://travis-ci.org/freemle/freemle-ruby)
+[![Coverage Status](https://coveralls.io/repos/freemle/freemle-ruby/badge.png)](https://coveralls.io/r/freemle/freemle-ruby)
+[![Code Climate](https://codeclimate.com/github/freemle/freemle-ruby.png)](https://codeclimate.com/github/freemle/freemle-ruby)
+
+A Ruby interface to the [Freemle](https://www.freemle.com/) REST API.
+
+## Usage
+
+To create a freemle client:
+```ruby
+freemle = Freemle::Client.new(
+  app_name: "application-name-as-chosen-on-freemle.com",
+  api_key: "api-key-as-provided-by-freemle.com"
+)
+```
+
+### Customers
+
+Accessing customers:
+```ruby
+freemle.customers.search('Freemle')
+[{
+  company_name: 'Freemle',
+  address: {
+    street: "Cruquiusweg 109 F",
+    postal_code: "1019 AG",
+    city: "Amsterdam",
+    country_code: "NL"
+  }
+},
+  company_name: 'Elmeerf',
+  address: {
+    street: "Freemleweg",
+    ...
+  }
+}]
+```
+
+Adding customers:
+```ruby
+customers.create(
+  company_name: "Zilverline B.V.",
+  address: {
+    street: "Cruquiusweg 109 F",
+    postal_code: "1019 AG",
+    city: "Amsterdam",
+    country_code: "NL"
+  }
+)
+```
+
+### Invoices
+
+Adding invoices:
+```ruby
+invoices.create(
+  customer_id: "123456789",
+)
+```
+## Documentation
+
+Check https://www.freemle.com/api-documentatie for more info.
+
+## Development
+
+### Running tests
+
+`bundle install` and then `rake spec` or `rspec spec`.
+
+### Building the gem
+
+`rake build` and then `rake install` to test it locally (`irb` followed
+by `require 'freemle/client'` and do your stuff).
+
+### Releasing the gem
+
+Make a fix, commit and push. Make sure the build is green. Then bump the
+version (edit `lib/freemle/client/version.rb`). Now `rake release` and follow
+the instructions (you need a rubygems.org account and permissions ;-)).

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

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'
+  spec.version       = Freemle::Client::VERSION
+  spec.authors       = ['Bob Forma', 'Steven Weller']
+  spec.email         = %w(bforma@zilverline.com suweller@zilverline.com)
+  spec.summary       = %w(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_runtime_dependency 'rest-client', '~> 1.6'
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'coveralls', '~> 0.7'
+  spec.add_development_dependency 'rake', '~> 10.3'
+  spec.add_development_dependency 'rspec', '~> 2.14'
+  spec.add_development_dependency 'webmock', '~> 1.17'
+end

data/lib/freemle/client.rb

@@ -0,0 +1,55 @@
+require "freemle/client/version"
+require "freemle/resource"
+
+module Freemle
+  class Client
+    BASE_URL = "https://www.freemle.com/api"
+
+    attr_accessor :base_url, :app_name, :api_key
+
+    # Initialize a Freemle client.
+    #
+    # @example
+    #   Freemle::Client.new(
+    #     app_name: <application-name, chosen in freemle.com>
+    #     api_key: <api-key, as provided by freemle.com>
+    #   )
+    #
+    # @params [ Hash ] opts Options for the client,
+    #   optionally including base_url.
+    #
+    # @return [ Freemle::Client ]
+    #
+    # @since 1.0.0
+    def initialize(opts)
+      self.base_url = opts.fetch(:base_url, BASE_URL)
+      self.app_name = opts.fetch(:app_name)
+      self.api_key = opts.fetch(:api_key)
+    end
+
+    # Access the customer resource.
+    #
+    # @example
+    #   client.customers
+    #
+    # @return [ Freemle::Resource ] entry to the customer resource.
+    #
+    # @since 1.0.0
+    def customers
+      @customers ||= Freemle::Resource.new(self, :customer, :customers)
+    end
+
+    # Access the invoice resource.
+    #
+    # @example
+    #   client.invoices
+    #
+    # @return [ Freemle::Resource ] entry to the invoice resource.
+    #
+    # @since 1.0.0
+    def invoices
+      @invoices ||= Freemle::Resource.new(self, :invoice, :invoices)
+    end
+
+  end
+end

data/lib/freemle/client/version.rb

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

data/lib/freemle/resource.rb

@@ -0,0 +1,100 @@
+require 'rest-client'
+
+module Freemle
+  class Resource < Struct.new(:config, :singular, :plural)
+
+    # Performs a search on this resource, given a query.
+    #
+    # @example
+    #   customers.search('Zilverline')
+    #
+    # @example
+    #   customers.search('Zilverline') do |response|
+    #     # Roll your own response handler
+    #   end
+    #
+    # @param [ Hash ] query A hash containing the fields to search for.
+    # @param [ Proc ] block A custom response handler.
+    #
+    # @return [ Array<Hash> ] By default, a JSON parsed response body.
+    #
+    # @since 1.0.0
+    def search(query, &block)
+      block = default_handler unless block_given?
+      request.get(params: {query: query}, &block)
+    end
+
+    # Persists a resource on freemle.com, given a payload.
+    #
+    # @example
+    #   customers.create(
+    #     company_name: "Zilverline B.V.",
+    #     address: {
+    #       street: "Cruquiusweg 109 F",
+    #       postal_code: "1019 AG",
+    #       city: "Amsterdam",
+    #       country_code: "NL"
+    #     }
+    #   )
+    #
+    # @example
+    #   customers.create(
+    #     company_name: "Zilverline B.V.",
+    #     address: {
+    #       street: "Cruquiusweg 109 F",
+    #       postal_code: "1019 AG",
+    #       city: "Amsterdam",
+    #       country_code: "NL"
+    #     }
+    #   ) do |response|
+    #     # Roll your own response handler
+    #   end
+    #
+    # @param [ Hash ] payload A hash containing the fields to set.
+    # @param [ Proc ] block A custom response handler.
+    #
+    # @return [ Hash ] By default, a JSON parsed response body.
+    #
+    # @since 1.0.0
+    def create(payload, &block)
+      block = default_handler unless block_given?
+      request.post(json.generate({singular => payload}), &block)
+    end
+
+  private
+
+    # Returns a response handler, which parses the response body as JSON.
+    #
+    # @return [ Proc ] Default response handler.
+    #
+    # @since 1.0.0
+    def default_handler
+      Proc.new { |response| json.parse(response.body) }
+    end
+
+    # Returns a new request handler for this resource.
+    #
+    # @return [ RestClient::Resource ] A request handler.
+    #
+    # @since 1.0.0
+    def request
+      RestClient::Resource.new(
+        "#{config.base_url}/#{plural}",
+        user: config.app_name,
+        password: config.api_key
+      )
+    end
+
+    # Returns the JSON library used in request and default response handling.
+    #
+    # @return [ Class ] A JSON library.
+    #
+    # @since 1.0.0
+    def json
+      return @json if @json
+      require 'json'
+      @json = JSON
+    end
+
+  end
+end

data/spec/freemle/client_spec.rb

@@ -0,0 +1,45 @@
+require "spec_helper"
+
+describe Freemle::Client do
+  describe "#initialize" do
+    subject { Freemle::Client.new(opts) }
+    let(:opts) { Hash.new }
+
+    specify { expect { subject }.to raise_error(KeyError) }
+
+    context "given app_name" do
+      before { opts[:app_name] = "name" }
+
+      specify { expect { subject }.to raise_error(KeyError) }
+
+      context "and api_key" do
+        before { opts[:api_key] = "secret" }
+
+        it { should be_instance_of(Freemle::Client) }
+        its(:base_url) { should eq(Freemle::Client::BASE_URL) }
+        its(:app_name) { should eq("name") }
+        its(:api_key) { should eq("secret") }
+      end
+    end
+  end
+
+  context "configured" do
+    let(:client) { Freemle::Client.new(app_name: "app", api_key: "secret") }
+
+    describe "#customers" do
+      subject { client.customers }
+
+      it { should be_instance_of(Freemle::Resource) }
+      its(:singular) { should eq(:customer) }
+      its(:plural) { should eq(:customers) }
+    end
+
+    describe "#invoices" do
+      subject { client.invoices }
+
+      it { should be_instance_of(Freemle::Resource) }
+      its(:singular) { should eq(:invoice) }
+      its(:plural) { should eq(:invoices) }
+    end
+  end
+end

data/spec/freemle/resource_spec.rb

@@ -0,0 +1,31 @@
+require "spec_helper"
+
+describe Freemle::Resource do
+  let(:client) do
+    double("client", base_url: "foo", app_name: "app", api_key: "secret")
+  end
+  let(:resource) { Freemle::Resource.new(client, :customer, :customers) }
+
+  describe "#search" do
+    subject { resource.search("terms") }
+
+    before do
+      stub_request(:get, "http://app:secret@foo/customers?query=terms").
+        to_return(status: 200, body: '{"customers": []}')
+    end
+
+    it { should eq("customers" => []) }
+  end
+
+  describe "#create" do
+    subject { resource.create(foo: :bar) }
+
+    before do
+      stub_request(:post, "http://app:secret@foo/customers").
+        with(body: '{"customer":{"foo":"bar"}}').
+        to_return(status: 201, body: '{"customer_id": "123"}')
+    end
+
+    it { should eq("customer_id" => "123") }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'simplecov'
+require 'coveralls'
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start
+# Coveralls.wear!
+
+require "rspec"
+require "webmock/rspec"
+
+require "freemle/client"

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: freemle
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Bob Forma
+- Steven Weller
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+description: 
+email:
+- bforma@zilverline.com
+- suweller@zilverline.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- freemle-client.gemspec
+- lib/freemle/client.rb
+- lib/freemle/client/version.rb
+- lib/freemle/resource.rb
+- spec/freemle/client_spec.rb
+- spec/freemle/resource_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/freemle/resource_spec.rb
+- spec/spec_helper.rb