pipe_line_dealer 0.1.0

data/.gitignore

@@ -0,0 +1,3 @@
+Gemfile.lock
+coverage/
+spec/api.key

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format Fuubar

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+script: bundle exec rspec
+notifications:
+  email:
+    - maarten+pld_travis@moretea.nl

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/Guardfile

@@ -0,0 +1,5 @@
+guard "rspec" do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
+  watch("spec/helper.rb") { "spec" }
+end

data/LICENCE

@@ -0,0 +1,7 @@
+Copyright (c) 2012 Maarten Hoogendoorn (maarten@springest.com)
+
+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,19 @@
+#Pipe line dealer
+
+[<img src="https://secure.travis-ci.org/moretea/pipe_line_dealer.png?travis"/>](http://travis-ci.org/moretea/pipe_line_dealer) [<img src="https://gemnasium.com/moretea/pipe_line_dealer.png?travis"/>](https://gemnasium.com/moretea/pipe_line_dealer)
+
+Pipe line dealer is client for the [pipe line deals api](http://www.pipelinedeals.com/developers/api).
+
+This gem is young. If you want to know anything, just send me a message.
+
+# Acceptance specs
+In order to run the acceptance tests agains the actual API, you'll need to provide an API key,
+and set the ```ACCEPTANCE=true``` environmental variable.
+This can be done either by providing it as another environmental variable ```API_KEY=secret```,
+or by adding a file in ```spec/api.key```  with the API key.
+
+# Thanks
+Many thanks to my employer [<img src="http://static-1.cdnhub.nl/images/logo-springest.jpg" alt="Springest">](http://springest.com/).
+
+
+They are awesome :) If you're looking for a [job (In the Netherlands)](http://www.springest.nl/weblog/vacature-ruby-on-rails-developer-in-amsterdam), check it out.

data/api_remarks.txt

@@ -0,0 +1,5 @@
+Improvements for pipelinedeals.com:
+- DELETE returns 200, and empty string. Could it return a valid JSON response?
+- If you try to save an invalid hash, we get a 500. Could this be changed to
+  unprocessable entity, and have the same error format as the other requests?
+- Make it possible to manage custom fields via the API.

data/lib/pipe_line_dealer/client/connection.rb

@@ -0,0 +1,71 @@
+module PipeLineDealer
+  class Client
+    class Connection
+      attr_accessor :cache
+
+      DEFAULT_OPTIONS = {
+        http_debug: false
+      }
+
+      def initialize(key, options)
+        @key        = key
+        @cache      = {}
+        @options    = DEFAULT_OPTIONS.merge options
+        @connection = build_connection
+      end
+
+      def build_connection
+        Faraday.new(url: ENDPOINT) do |faraday|
+          faraday.request  :url_encoded
+          faraday.response :logger if @options[:http_debug]
+          faraday.adapter  Faraday.default_adapter
+        end
+      end
+
+      def cache(key, &block)
+        if not @cache.has_key?(key)
+          @cache[key] = block.call
+        end
+
+        @cache[key]
+      end
+
+      # HTTP methods
+      [:get, :post, :put, :delete].each do |method|
+        class_eval <<-RUBY
+          def #{method} url, params = {}
+            request(:#{method}, url, params)
+          end
+        RUBY
+      end
+
+      protected
+
+      def request(method, request_url, params)
+        begin
+          case method
+          when :get, :delete
+            request_params = params.merge(api_key: @key)
+            query = Faraday::Utils.build_nested_query(request_params)
+            response = @connection.send(method, request_url + "?" + query)
+          when :post, :put
+            request_url += "?api_key=#{@key}"
+            body = Faraday::Utils.build_nested_query(params)
+            response = @connection.send(method, request_url, body)
+          end
+
+          if method == :delete
+            # Bwelch. Only a delete doesn't return valid json :(
+            return [response.status, JSON.parse('{ "msg": "' + response.body + '" }')]
+          else
+            return [response.status, JSON.parse(response.body)]
+          end
+        end
+      end
+
+      def debug?
+        ENV['DEBUG'] == "true"
+      end
+    end
+  end
+end

data/lib/pipe_line_dealer/client.rb

@@ -0,0 +1,27 @@
+module PipeLineDealer
+  ENDPOINT = "https://api.pipelinedeals.com/api/v3/"
+
+  class Client
+    attr_reader :connection
+
+    def initialize(api_key, options = {})
+      @connection = Connection.new(api_key, options)
+    end
+
+    def companies
+      Collection.new(self, klass: Company)
+    end
+
+    def custom_company_fields
+      CustomField::Collection.new(self, klass: Company::CustomField)
+    end
+
+    def people
+      Collection.new(self, klass: Person)
+    end
+
+    def custom_person_fields
+      CustomField::Collection.new(self, klass: Person::CustomField)
+    end
+  end
+end

data/lib/pipe_line_dealer/collection/concerns/create_and_update.rb

@@ -0,0 +1,25 @@
+module PipeLineDealer
+  class Collection
+    module Concerns
+      module CreateAndUpdate
+        extend ActiveSupport::Concern
+
+        def create(attributes = {})
+          if @options[:new_defaults]
+            attributes = @options[:new_defaults].merge(attributes)
+          end
+
+          @klass.new(collection: self, record_new: true, attributes: attributes).save
+        end
+
+        def new(attributes = {})
+          if @options[:new_defaults]
+            attributes = @options[:new_defaults].merge(attributes)
+          end
+
+          @klass.new(collection: self, record_new: true, attributes: attributes)
+        end
+      end
+    end
+  end
+end

data/lib/pipe_line_dealer/collection/concerns/fetching.rb

@@ -0,0 +1,64 @@
+module PipeLineDealer
+  class Collection
+    module Concerns
+      module Fetching
+        extend ActiveSupport::Concern
+
+        def where(opts)
+          new_options = @options.merge(where: opts)
+          self.class.new(@client, new_options)
+        end
+
+        def on_new_defaults(opts)
+          new_options = @options.merge(new_defaults: opts)
+          self.class.new(@client, new_options)
+        end
+
+        def all
+          if @options[:cached]
+            @client.connection.cache(@options[:cache_key]) { self.to_a }
+          else
+            self
+          end
+        end
+
+        def limit(lmt)
+          refine(limit: lmt)
+        end
+
+        def first
+          self.limit(1).to_a.first
+        end
+
+        def to_a
+          array = []
+          self.each { |item| array << item }
+
+          array
+        end
+
+        def each &block
+          options = @options.dup
+          ResultsFetcher.new(self, options).each &block
+        end
+
+        #TODO: Not speced
+        def find id
+          status, result = @client.connection.get(collection_url + "/#{id}.json", {})
+          if status == 200
+            @klass.new(collection: self, persisted: true, attributes: result)
+          else
+            raise Error::NotFound
+          end
+        end
+
+        protected
+
+        # Refine the criterea
+        def refine(refinements)
+          self.class.new(@client, @options.merge(refinements))
+        end
+      end
+    end
+  end
+end

data/lib/pipe_line_dealer/collection/concerns/results_fetcher.rb

@@ -0,0 +1,64 @@
+module PipeLineDealer
+  class Collection
+    module Concerns
+      class ResultsFetcher
+        attr_reader :options
+
+        def initialize(collection, options)
+          @collection = collection
+          @options = options
+        end
+
+        def limit
+          options[:limit] || PipeLineDealer::Limits::MAX_RESULTS_PER_PAGE
+        end
+
+        def each &block
+          @params =  { page: 1, per_page: PipeLineDealer::Limits::MAX_RESULTS_PER_PAGE }
+
+          @results_yielded = 0
+
+          # Enforce maximum number of resulst per page.
+          if limit && limit > PipeLineDealer::Limits::MAX_RESULTS_PER_PAGE
+            options[:limit] = PipeLineDealer::Limits::MAX_RESULTS_PER_PAGE
+          end
+
+          @params[:per_page] = limit
+
+          #TODO: refactor this deal specific piece of code.
+          if options.has_key?(:where) && options[:where].has_key?(:query) && options[:where][:query].has_key?(:company_id)
+            @params[:company_id] = options[:where][:query][:company_id].to_s
+          end
+
+          catch :stop_yielding do
+            while true
+              status, result = @collection.client.connection.get(@collection.collection_url + ".json", @params)
+
+              if status == 200
+                yield_results(result, &block)
+              else # status != 200
+                #TODO
+                raise "Unexpected status #{status.inspect}"
+              end
+            end
+          end
+        end
+
+        def yield_results result, &block
+          result["entries"].each do |entry|
+            block.call(@collection.klass.new(collection: @collection, persisted: true, attributes: entry))
+            @results_yielded += 1
+
+            throw :stop_yielding if @results_yielded >= limit
+          end
+
+          if result["pagination"]["page"] < result["pagination"]["pages"]
+            @params[:page] += 1
+          else
+            throw :stop_yielding
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pipe_line_dealer/collection/concerns.rb

@@ -0,0 +1,6 @@
+module PipeLineDealer
+  class Collection
+    module Concerns
+    end
+  end
+end

data/lib/pipe_line_dealer/collection.rb

@@ -0,0 +1,24 @@
+module PipeLineDealer
+  class Collection
+    include Concerns::Fetching
+    include Concerns::CreateAndUpdate
+
+    DEFAULT_OPTIONS = { cached: false }
+
+    attr_reader :client
+    attr_reader :klass
+    def initialize(client, options = {})
+      @options = DEFAULT_OPTIONS.merge(options)
+      @client = client
+      @klass  = options[:klass]
+    end
+
+    def to_s
+      "<PipeLineDealer::Collection:#{__id__} @klass=#{@klass.inspect}>"
+    end
+
+    def collection_url
+      @klass.instance_variable_get(:@collection_url)
+    end
+  end
+end

data/lib/pipe_line_dealer/custom_field/collection.rb

@@ -0,0 +1,18 @@
+module PipeLineDealer
+  class CustomField
+    class Collection < PipeLineDealer::Collection
+      def initialize(client, options={})
+        options[:cached] = true
+        super(client, options)
+      end
+
+      def [](key)
+        self.all.each do |item|
+          return item if item.name== key
+        end
+
+        raise PipeLineDealer::Error::NoSuchCustomField.new(key)
+      end
+    end
+  end
+end

data/lib/pipe_line_dealer/custom_fields.rb

@@ -0,0 +1,59 @@
+# "Plugin"
+
+module PipeLineDealer
+  module CustomFields
+    extend ActiveSupport::Concern
+
+    included do
+      attr_reader :custom_fields
+    end
+
+    CUSTOM_FIELD_PREFIX = "custom_label_"
+    CUSTOM_FIELD_REGEX  = /#{CUSTOM_FIELD_PREFIX}(\d+)/
+
+    module InstanceMethods
+      protected
+
+      def custom_field_collection
+        method = self.class.instance_variable_get(:@custom_field_client_method)
+        @collection.client.send(method).all
+      end
+
+      def process_attributes
+        @custom_fields = pld2human_fields(@attributes.delete(:custom_fields))
+      end
+
+      def attributes_for_saving attributes
+        attributes.merge("custom_fields" => human2pld_fields(@custom_fields))
+      end
+
+      def pld2human_fields attributes
+        attributes ||= {}
+        result = {}
+
+        attributes.each do |key, value|
+          field_id = CUSTOM_FIELD_REGEX.match(key)[1].to_i
+          field = custom_field_collection.select { |field| field.id == field_id }.first
+
+          raise Error::InvalidAttributeName.new(self, key) if field.nil?
+          result[field.name] = field.decode(self, value)
+        end
+
+        result
+      end
+
+      def human2pld_fields attributes
+        attributes ||= {}
+        result = HashWithIndifferentAccess.new
+
+        attributes.each do |name, value|
+          field = custom_field_collection.select { |field| field.name == name}.first
+          raise Error::InvalidAttributeName.new(self, name) if field.nil?
+          result[CUSTOM_FIELD_PREFIX + field.id.to_s] = field.encode(self, value)
+        end
+
+        result
+      end
+    end
+  end
+end

data/lib/pipe_line_dealer/error/connection.rb

@@ -0,0 +1,17 @@
+module PipeLineDealer
+  class Error
+    class Connection < PipeLineDealer::Error
+    end
+
+    class Connection
+      class Unprocessable < Error::Connection
+        attr_reader :errors
+
+        def initialize(errors)
+          @errors = errors
+          @message = "Couldn't save to the server: #{errors.inspect}"
+        end
+      end
+    end
+  end
+end

data/lib/pipe_line_dealer/error/invalid_attribute.rb

@@ -0,0 +1,29 @@
+module PipeLineDealer
+  class Error
+    class InvalidAttribute < PipeLineDealer::Error
+      attr_reader :attribute_name
+
+      def initialize(klass, attribute_name)
+        @klass = klass
+        @attribute_name = attribute_name
+      end
+    end
+
+    class InvalidAttributeName < InvalidAttribute
+      def initialize(klass, attribute_name)
+        super
+        @message = "The attribute #{attribute_name.inspect} is not known by #{klass.inspect}!"
+      end
+    end
+
+    class InvalidAttributeValue < InvalidAttribute
+      attr_reader :value
+
+      def initialize(klass, attribute_name, value)
+        super(klass, attribute_name)
+        @value = value
+        @message = "The attribute #{attribute_name.inspect} does not accept the value #{value.inspect} (on model #{klass.inspect})"
+      end
+    end
+  end
+end

data/lib/pipe_line_dealer/error/no_such_custom_field.rb

@@ -0,0 +1,12 @@
+module PipeLineDealer
+  class Error
+    class NoSuchCustomField < PipeLineDealer::Error
+      attr_reader :name
+
+      def initialize(name)
+        @name = name
+        @message = "Could not find a custom field with the name #{name.inspect}"
+      end
+    end
+  end
+end

data/lib/pipe_line_dealer/error.rb

@@ -0,0 +1,9 @@
+module PipeLineDealer
+  class Error < Exception
+    attr_reader :message
+
+    def to_s
+      @message
+    end
+  end
+end

data/lib/pipe_line_dealer/limits.rb

@@ -0,0 +1,7 @@
+module PipeLineDealer
+  # There are the limits of the API
+  class Limits
+    MAX_RESULTS_PER_PAGE    = 200
+    MAX_REQUESTS_PER_SECOND = 1
+  end
+end

data/lib/pipe_line_dealer/model/base/concern/persistance.rb

@@ -0,0 +1,69 @@
+module PipeLineDealer
+  module Model
+    class Base
+      module Concern
+        module Persistance
+          include ActiveSupport::Concern
+
+          def new_record?
+            not @persisted
+          end
+
+          def persisted?
+            @persisted
+          end
+
+          IGNORE_ATTRIBUTES_WHEN_SAVING = [:updated_at, :created_at]
+
+          def save
+            # Use :post for new records, :put for existing ones
+            method = new_record? ? :post : :put
+
+            # Ignore some attributes
+            save_attrs = @attributes.reject { |k, v| IGNORE_ATTRIBUTES_WHEN_SAVING.member?(k) }
+
+            # And allow a model class to modify / edit attributes even further
+            if respond_to?(:attributes_for_saving)
+              save_attrs = attributes_for_saving(save_attrs)
+            end
+
+            # Execute the request
+            status, response = @collection.client.connection.send(method, object_url, model_attribute_name => save_attrs)
+
+            if status == 200
+              import_attributes!(response) # Set the stuff.
+              self
+            elsif status == 422
+              errors = response.collect { |error| { field: error["field"], message: error["msg"] } }
+              raise Error::Connection::Unprocessable.new(errors)
+            else
+              raise "Unexepcted response status #{status.inspect}"
+            end
+          end
+
+          def destroy
+            status, response = @collection.client.connection.send(:delete, object_url)
+            #TODO: Check response
+
+            if status == 200 && response["msg"] == " "
+              @destroyed = true #todo: store that this model has been destroyed.
+              true
+            else
+              false
+            end
+          end
+
+          protected
+
+          def object_url
+            if persisted?
+              @collection.send(:collection_url) + "/" + self.id.to_s + ".json"
+            else
+              @collection.send(:collection_url) + ".json"
+            end
+          end
+        end
+      end
+    end
+  end
+end