freemle 1.0.0 → 1.0.1

checksums.yaml

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

data/README.md

@@ -10,7 +10,7 @@ A Ruby interface to the [Freemle](https://www.freemle.com/) REST API.
 
 To create a freemle client:
 ```ruby
-freemle = Freemle::Client.new(
+freemle = Freemle.client(
   app_name: "application-name-as-chosen-on-freemle.com",
   api_key: "api-key-as-provided-by-freemle.com"
 )
@@ -18,9 +18,8 @@ freemle = Freemle::Client.new(
 
 ### Customers
 
-Accessing customers:
+Accessing customers (`freemle.customers.search('Freemle')`) returns:
 ```ruby
-freemle.customers.search('Freemle')
 [{
   company_name: 'Freemle',
   address: {
@@ -40,8 +39,10 @@ freemle.customers.search('Freemle')
 
 Adding customers:
 ```ruby
-customers.create(
+freemle.customers.create(
   company_name: "Zilverline B.V.",
+  attn: "Vibiemme", # Optional
+  extra_information: "The best cofee maker!", # Optional
   address: {
     street: "Cruquiusweg 109 F",
     postal_code: "1019 AG",
@@ -55,10 +56,16 @@ customers.create(
 
 Adding invoices:
 ```ruby
-invoices.create(
-  customer_id: "123456789",
+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://www.freemle.com/api-documentatie for more info.

data/freemle-client.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   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.summary       = 'Freemle.com REST API client'
   spec.homepage      = 'https://www.freemle.com/api-documentatie'
   spec.license       = 'MIT'
 
@@ -19,9 +19,9 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency 'rest-client', '~> 1.6'
 
-  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'bundler', '~> 1.0'
   spec.add_development_dependency 'coveralls', '~> 0.7'
-  spec.add_development_dependency 'rake', '~> 10.3'
+  spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 2.14'
   spec.add_development_dependency 'webmock', '~> 1.17'
 end

data/lib/freemle.rb

@@ -0,0 +1,16 @@
+require 'freemle/client'
+require 'freemle/client/version'
+
+module Freemle
+
+  # Convenient way to initialize a freemle client.
+  #
+  # @see {Freemle::Client.initialize}
+  #
+  # @since 1.0.1
+  def client(*args)
+    Freemle::Client.new(*args)
+  end
+  module_function :client
+
+end

data/lib/freemle/client.rb

@@ -1,9 +1,9 @@
-require "freemle/client/version"
-require "freemle/resource"
+require 'freemle/client/resource'
 
 module Freemle
+
   class Client
-    BASE_URL = "https://www.freemle.com/api"
+    BASE_URL = 'https://www.freemle.com/api'
 
     attr_accessor :base_url, :app_name, :api_key
 
@@ -32,11 +32,11 @@ module Freemle
     # @example
     #   client.customers
     #
-    # @return [ Freemle::Resource ] entry to the customer resource.
+    # @return [ Freemle::Client::Resource ] entry to the customer resource.
     #
     # @since 1.0.0
     def customers
-      @customers ||= Freemle::Resource.new(self, :customer, :customers)
+      @customers ||= new_resource(self, :customer, :customers)
     end
 
     # Access the invoice resource.
@@ -44,11 +44,22 @@ module Freemle
     # @example
     #   client.invoices
     #
-    # @return [ Freemle::Resource ] entry to the invoice resource.
+    # @return [ Freemle::Client::Resource ] entry to the invoice resource.
     #
     # @since 1.0.0
     def invoices
-      @invoices ||= Freemle::Resource.new(self, :invoice, :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

data/lib/freemle/client/resource.rb

@@ -0,0 +1,102 @@
+require 'rest-client'
+
+module Freemle
+  class Client
+    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
+end

data/lib/freemle/client/version.rb

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

data/spec/freemle/client_spec.rb

@@ -29,7 +29,7 @@ describe Freemle::Client do
     describe "#customers" do
       subject { client.customers }
 
-      it { should be_instance_of(Freemle::Resource) }
+      it { should be_instance_of(Freemle::Client::Resource) }
       its(:singular) { should eq(:customer) }
       its(:plural) { should eq(:customers) }
     end
@@ -37,7 +37,7 @@ describe Freemle::Client do
     describe "#invoices" do
       subject { client.invoices }
 
-      it { should be_instance_of(Freemle::Resource) }
+      it { should be_instance_of(Freemle::Client::Resource) }
       its(:singular) { should eq(:invoice) }
       its(:plural) { should eq(:invoices) }
     end

data/spec/freemle/resource_spec.rb

@@ -1,10 +1,10 @@
 require "spec_helper"
 
-describe Freemle::Resource do
+describe Freemle::Client::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) }
+  let(:resource) { Freemle::Client::Resource.new(client, :customer, :customers) }
 
   describe "#search" do
     subject { resource.search("terms") }

data/spec/freemle_spec.rb

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

data/spec/spec_helper.rb

@@ -8,7 +8,7 @@ SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
 SimpleCov.start
 # Coveralls.wear!
 
-require "rspec"
-require "webmock/rspec"
+require 'rspec'
+require 'webmock/rspec'
 
-require "freemle/client"
+require 'freemle'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: freemle
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Bob Forma
@@ -31,14 +31,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -59,14 +59,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.3'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.3'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -111,11 +111,13 @@ files:
 - README.md
 - Rakefile
 - freemle-client.gemspec
+- lib/freemle.rb
 - lib/freemle/client.rb
+- lib/freemle/client/resource.rb
 - lib/freemle/client/version.rb
-- lib/freemle/resource.rb
 - spec/freemle/client_spec.rb
 - spec/freemle/resource_spec.rb
+- spec/freemle_spec.rb
 - spec/spec_helper.rb
 homepage: https://www.freemle.com/api-documentatie
 licenses:
@@ -140,8 +142,9 @@ rubyforge_project:
 rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
-summary: "[\"Freemle.com\", \"REST\", \"API\", \"client\"]"
+summary: Freemle.com REST API client
 test_files:
 - spec/freemle/client_spec.rb
 - spec/freemle/resource_spec.rb
+- spec/freemle_spec.rb
 - spec/spec_helper.rb

data/lib/freemle/resource.rb

@@ -1,100 +0,0 @@
-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