jortt 2.0.0 → 5.0.0

data/.rubocop.yml

@@ -1,26 +0,0 @@
-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/lib/freemle.rb

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

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

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

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

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

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