jortt 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 77c2bef2b81e18794d1f60872ba00fb5a267d2e1
+  data.tar.gz: be437bdf4b8d419736c7d5a08f963931a1b70826
+SHA512:
+  metadata.gz: 685dcfac26a6f566ec4f074f6e44908b219cd1e8c094fb4c3bb4bee0962879aee17feb09e086a16e704755434a08d0e96c68f55121a0d69a316dca9a80480b39
+  data.tar.gz: c7b5c30f5d1417acaecf3d736e0b9bf8fcdb985bdae26bd56abba674037ca445454b8da71e63fcb434197fe0a245f004b2956f1a2ca082057520bd416b97fb9d

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/.rubocop.yml

@@ -0,0 +1,26 @@
+require: rubocop-rspec
+
+Style/AccessModifierIndentation:
+  EnforcedStyle: outdent
+
+Style/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Style/DotPosition:
+  EnforcedStyle: trailing
+
+Style/TrailingComma:
+  EnforcedStyleForMultiline: comma
+
+Style/EmptyLinesAroundBody:
+  Description: "Keeps track of empty lines around expression bodies."
+  Enabled: false
+
+Style/RegexpLiteral:
+  MaxSlashes: 0
+
+Style/HashSyntax:
+  EnforcedStyle: ruby19
+
+Style/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space

data/.ruby-version

@@ -0,0 +1 @@
+2.1.5

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.1.5
+script:
+  - bundle exec rspec
+  - bundle exec rubocop

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in jortt.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,99 @@
+# Freemle REST API client
+
+[![Inline docs](
+http://inch-ci.org/github/jorttbv/jortr-ruby.svg?branch=master&style=flat
+)](http://inch-ci.org/github/jorttbv/jortt-ruby)
+[![Code Climate](
+http://img.shields.io/codeclimate/github/jorttbv/jortt-ruby.svg?style=flat
+)](https://codeclimate.com/github/jorttbv/jortt-ruby)
+[![Coverage Status](
+http://img.shields.io/coveralls/jorttbv/jortt-ruby.svg?style=flat
+)](https://coveralls.io/r/jorttbv/jortt-ruby)
+[![Build Status](
+http://img.shields.io/travis/jorttbv/jortt-ruby.svg?style=flat
+)](https://travis-ci.org/jorttbv/jortt-ruby)
+
+A Ruby interface to the [Jortt](https://www.jortt.nl/) REST API.
+
+## Usage
+
+Note: The client is still called Freemle for historic reasons. Name change on its way...
+
+To create a freemle client:
+```ruby
+freemle = Freemle.client(
+  app_name: "application-name-as-chosen-on-jortt.nl",
+  api_key: "api-key-as-provided-by-jortt.nl"
+)
+```
+
+### Customers
+
+Accessing customers (`freemle.customers.search('Jortt')`) returns:
+```ruby
+[{
+  company_name: 'Jortt',
+  address: {
+    street: "Transistorstraat 71C",
+    postal_code: "1322 CK",
+    city: "Almere",
+    country_code: "NL"
+  }
+},
+  company_name: 'ttroj',
+  address: {
+    street: "Jorttweg",
+    ...
+  }
+}]
+```
+
+Adding customers:
+```ruby
+freemle.customers.create(
+  company_name: "Jortt B.V.",
+  attn: "Vibiemme", # Optional
+  extra_information: "The best cofee maker!", # Optional
+  address: {
+    street: "Transistorstraat 71C",
+    postal_code: "1322 CK",
+    city: "Almere",
+    country_code: "NL"
+  }
+)
+```
+
+### Invoices
+
+Adding invoices:
+```ruby
+freemle.invoices.create(
+  customer_id: "123456789", # Optional
+  delivery_period: "31-12-1234", # Optional
+  reference: "my-reference", # Optional
+  line_items: [
+    {vat: 21, amount: 1359.50, quantity: 1, description: "Scrum Training"}
+  ]
+)
+```
+
+## Documentation
+
+Check https://app.jortt.nl/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,6 @@
+# encoding: UTF-8
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/jortt.gemspec

@@ -0,0 +1,29 @@
+# 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          = 'jortt'
+  spec.version       = Freemle::Client::VERSION
+  spec.authors       = ['Bob Forma', 'Steven Weller', 'Lars Vonk']
+  spec.email         = %w(bforma@zilverline.com suweller@zilverline.com lvonk@zilverline.com)
+  spec.summary       = 'jortt.nl REST API client'
+  spec.homepage      = 'https://www.jortt.nl/api-documentatie'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^exec/}) { |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.0'
+  spec.add_development_dependency 'coveralls', '~> 0.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 2.14'
+  spec.add_development_dependency 'webmock', '~> 1.17'
+  spec.add_development_dependency 'rubocop', '~> 0.24.1'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.1.0'
+end

data/lib/freemle.rb

@@ -0,0 +1,22 @@
+# encoding: UTF-8
+require 'freemle/client'
+require 'freemle/client/version'
+
+##
+# This module contains everything needed to setup a connection to the Freemle
+# API. It's only method returns a configured Freemle::Client.
+module Freemle
+
+  # Convenient way to initialize a freemle client.
+  #
+  # @see {Freemle::Client.initialize}
+  #
+  # @return [ Freemle::Client ] a new freemle client instance
+  #
+  # @since 1.0.1
+  def client(*args)
+    Freemle::Client.new(*args)
+  end
+  module_function :client
+
+end

data/lib/freemle/client.rb

@@ -0,0 +1,69 @@
+# encoding: UTF-8
+require 'freemle/client/resource'
+
+module Freemle
+  ##
+  # This class is the main interface used to communicate with the Freemle API.
+  # It is by the {Freemle} module to create configured instances.
+  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::Client::Resource ] entry to the customer resource.
+    #
+    # @since 1.0.0
+    def customers
+      @customers ||= new_resource(self, :customer, :customers)
+    end
+
+    # Access the invoice resource.
+    #
+    # @example
+    #   client.invoices
+    #
+    # @return [ Freemle::Client::Resource ] entry to the invoice resource.
+    #
+    # @since 1.0.0
+    def invoices
+      @invoices ||= new_resource(self, :invoice, :invoices)
+    end
+
+  private
+
+    # Creates a freemle client resource based on the passed configuration
+    #
+    # @return [ Freemle::Client::Resource ] entry to a resource.
+    #
+    # @since 1.0.1
+    def new_resource(*args)
+      Freemle::Client::Resource.new(*args)
+    end
+
+  end
+end

data/lib/freemle/client/resource.rb

@@ -0,0 +1,140 @@
+# encoding: UTF-8
+require 'rest-client'
+
+module Freemle # :nodoc:
+  class Client # :nodoc:
+    ##
+    # This class is used by {Freemle::Client} internally.
+    # It wraps rest API calls of a single resource,
+    # so they can easily be used using the client DSL.
+    #
+    # @see { Freemle::Client.customer }
+    class Resource
+
+      # Details needed to connect to this resource, see
+      # +Freemle::Client#initialize+
+      #
+      # @since 1.0.0
+      attr_accessor :config
+
+      # The singular form, posted to and returned when describing
+      # a single member of this resource.
+      #
+      # @since 1.0.0
+      attr_accessor :singular
+
+      # Used to describe multiple members of this resource.
+      #
+      # @since 1.0.0
+      attr_accessor :plural
+
+      # Creates a new resource instance.
+      #
+      # @see { Freemle::Client#new_resource }
+      #
+      # @returns [ Freemle::Client::Resource ] bound to the resource
+      # defined by +singular+ & +plural+
+      #
+      # @since 1.0.0
+      def initialize(config, singular, plural)
+        self.config = config
+        self.singular = singular
+        self.plural = plural
+      end
+
+      # 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 { |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/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
+end

data/lib/freemle/client/version.rb

@@ -0,0 +1,7 @@
+# encoding: UTF-8
+module Freemle
+  # Define the version of +Freemle::Client+
+  class Client
+    VERSION = '2.0.0'
+  end
+end

data/spec/freemle/client/resource_spec.rb

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

data/spec/freemle/client_spec.rb

@@ -0,0 +1,43 @@
+# encoding: UTF-8
+require 'spec_helper'
+
+describe Freemle::Client do
+  describe '#initialize' do
+    subject { described_class.new(opts) }
+    let(:opts) { {} }
+
+    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(described_class) }
+        its(:base_url) { should eq(described_class::BASE_URL) }
+        its(:app_name) { should eq('name') }
+        its(:api_key) { should eq('secret') }
+      end
+    end
+  end
+
+  context 'configured' do
+    let(:client) { described_class.new(app_name: 'app', api_key: 'secret') }
+
+    describe '#customers' do
+      subject { client.customers }
+      it { should be_instance_of(described_class::Resource) }
+      its(:singular) { should eq(:customer) }
+      its(:plural) { should eq(:customers) }
+    end
+
+    describe '#invoices' do
+      subject { client.invoices }
+      it { should be_instance_of(described_class::Resource) }
+      its(:singular) { should eq(:invoice) }
+      its(:plural) { should eq(:invoices) }
+    end
+  end
+end

data/spec/freemle_spec.rb

@@ -0,0 +1,9 @@
+# encoding: UTF-8
+require 'spec_helper'
+
+describe Freemle do
+  describe '.client' do
+    subject { described_class.client(app_name: 'name', api_key: 'secret') }
+    it { should be_instance_of(described_class::Client) }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+# encoding: UTF-8
+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'

metadata

@@ -0,0 +1,181 @@
+--- !ruby/object:Gem::Specification
+name: jortt
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- Bob Forma
+- Steven Weller
+- Lars Vonk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-19 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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.24.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.24.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+description: 
+email:
+- bforma@zilverline.com
+- suweller@zilverline.com
+- lvonk@zilverline.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- jortt.gemspec
+- lib/freemle.rb
+- lib/freemle/client.rb
+- lib/freemle/client/resource.rb
+- lib/freemle/client/version.rb
+- spec/freemle/client/resource_spec.rb
+- spec/freemle/client_spec.rb
+- spec/freemle_spec.rb
+- spec/spec_helper.rb
+homepage: https://www.jortt.nl/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.2
+signing_key: 
+specification_version: 4
+summary: jortt.nl REST API client
+test_files:
+- spec/freemle/client/resource_spec.rb
+- spec/freemle/client_spec.rb
+- spec/freemle_spec.rb
+- spec/spec_helper.rb