leadcli 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 44b485ed30fd5d722aadf779a7ddce956a7592ad
+  data.tar.gz: 14fa115187f897aad9c3f7f3f45fc49b81df8558
+SHA512:
+  metadata.gz: 94c93ae8b73f6144858541d663f277984e70a88921f44b73eb4635d3b92d0aaeadb374aa7de78a3b0ec10e761b10284b3439db6edc27327959dce4d9ba26f187
+  data.tar.gz: 8c0b866aa045f949105ac16a242f2d91b6c5215e49b4cc9cae2e47b3b1ea15c10e27da0705b4b932383021f3bea3b206a451dc2b090c273bfc3fb7d525465e7b

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cvtcli.gemspec
+gemspec
+

data/Gemfile.lock

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    leadcli (0.0.2)
+      rest-client
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    domain_name (0.5.24)
+      unf (>= 0.0.5, < 1.0.0)
+    fakeweb (1.3.0)
+    http-cookie (1.0.2)
+      domain_name (~> 0.5)
+    mime-types (2.6.1)
+    netrc (0.10.3)
+    rest-client (1.8.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 3.0)
+      netrc (~> 0.7)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.2)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  fakeweb
+  leadcli!
+  rspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Franck D'agostini
+
+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,46 @@
+# Leadcli
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'leadcli'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install leadcli
+
+## Usage
+
+```ruby
+class ContactController < ApplicationController
+
+  def create
+    @contact = Contact.new(params_contact)
+    if @contact.save
+      send_lead(params_contact)
+      redirect_to thanks_contact_path
+    else
+      render :new
+    end
+  end
+
+  protected
+
+  def send_lead(params)
+    info = {
+      subject: "Contact",
+      content: params[:content],
+      name: params[:name],
+      email: params[:email]
+    }
+    Leadcli.send(info)
+  end
+  
+end
+```
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/leadcli.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'leadcli/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "leadcli"
+  gem.version       = Leadcli::VERSION
+  gem.authors       = ["Franck D'agostini"]
+  gem.email         = ["franck.dagostini@gmail.com"]
+  gem.description   = %q{Client gem for Leadheque server api}
+  gem.summary       = %q{Client gem for Leadheque server api}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  
+  gem.add_dependency('rest-client')
+
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency('fakeweb')
+end
+

data/lib/leadcli/api_call.rb

@@ -0,0 +1,8 @@
+module Leadcli
+  module ApiCall
+    def api_call(endpoint, options={})
+      api_caller = Leadcli::ApiCaller.new(endpoint, options)
+      api_caller.call(self)
+    end
+  end
+end

data/lib/leadcli/api_caller.rb

@@ -0,0 +1,82 @@
+require 'rest-client'
+
+module Leadcli
+  class ApiCaller
+    include ::Leadcli::Routes
+
+    attr_accessor :max_connection_attempts
+    attr_reader :endpoint, :options, :connection_attempts
+
+    DEFAULT_RETRY_LIMIT = 1
+
+    def initialize(endpoint, options={})
+      @endpoint, @options = endpoint, options
+      @connection_attempts = 0
+      @max_connection_attempts = options[:max_connection_attempts] || DEFAULT_RETRY_LIMIT
+    end
+
+    def call(obj)
+      method, url = send("#{endpoint}_endpoint", options[:url_options] || {})
+      Leadcli.debug("API CALL: #{method} #{url}")
+
+      while connection_attempts < max_connection_attempts
+        sleep_if_retrying
+
+        response = make_call(method, url)
+        valid_response_codes = (200..207).to_a
+        if valid_response_codes.include?(response.code.to_i)
+          if options[:success]
+            Leadcli.debug("CALLING SUCCESS HANDLER: #{options[:success]}")
+            obj.send(options[:success], response)
+          end
+          success = true
+          break
+        end
+      end
+
+      if !success && options[:failure]
+        obj.send(options[:failure], response)
+      end
+    rescue Errno::ECONNREFUSED => error
+      Leadcli.debug("Remote server down : #{error}")
+    end
+
+    private
+
+    def make_call(method, url)
+      begin
+        @connection_attempts += 1
+        Leadcli.debug("ATTEMPT #{@connection_attempts}")
+        headers =  {
+          "AUTHORIZATION" => "Token token=\"#{Leadcli.configuration.token}\"",
+          :content_type => :json,
+          :accept => :json
+        }
+        parameters = {
+          url: url,
+          method: method,
+          headers: headers
+        }
+        parameters[:payload] = options[:payload] if method == :post or method == :put
+        RestClient::Request.execute(parameters)
+      rescue RestClient::ResourceNotFound,
+        RestClient::NotModified,
+        RestClient::InternalServerError,
+        RestClient::BadGateway,
+        RestClient::ServiceUnavailable,
+        RestClient::UnprocessableEntity,
+        RestClient::GatewayTimeout => error
+        return error.response
+      end
+    end
+
+    def sleep_if_retrying
+      if @connection_attempts > 0
+        time = @connection_attempts * 5
+        Leadcli.debug("Sleeping for #{time} before retrying")
+        sleep time
+      end
+    end
+  end
+end
+

data/lib/leadcli/configuration.rb

@@ -0,0 +1,26 @@
+module Leadcli
+  class Configuration
+
+    attr_accessor :host
+    attr_accessor :port
+    attr_accessor :secure
+    attr_accessor :token
+    attr_accessor :logger
+
+    def initialize
+      defaults.each do |setting, value|
+        send("#{setting}=", value)
+      end
+    end
+
+    def defaults
+      defaults = {
+        host: 'new.eureo-tools.com'
+      }
+      #defaults[:logger] = Logger.new(STDOUT)
+    end
+
+  end
+end
+
+

data/lib/leadcli/lead.rb

@@ -0,0 +1,36 @@
+require "leadcli/api_call"
+
+module Leadcli
+  class Lead
+    include Leadcli::ApiCall
+
+    attr_accessor :responses
+    
+    def initialize
+      @responses = []
+    end
+
+    def create(params)
+      api_call :create, url_options: {}, payload: { lead: params }, failure: :handle_failure, success: :handle_success
+    end
+
+    def delete(lead_id)
+      api_call :delete, url_options: { id: lead_id }, failure: :handle_failure, success: :handle_success
+    end
+
+    def handle_failure(response)
+      Leadcli.debug("LEAD API CALL FAILED : #{response}")
+      @responses << response
+    end
+
+    def handle_success(response)
+      @responses << response
+    end
+
+    def last_response
+      @responses.last
+    end
+
+  end
+end
+

data/lib/leadcli/rails.rb

@@ -0,0 +1,16 @@
+module Leadcli
+  module Rails
+    def self.initialize
+      if defined?(::Rails.logger)
+        rails_logger = ::Rails.logger
+      elsif defined?(RAILS_DEFAULT_LOGGER)
+        rails_logger = RAILS_DEFAULT_LOGGER
+      end
+
+      Leadcli.configure do |config|
+        config.logger = rails_logger
+      end
+    end
+  end
+end
+

data/lib/leadcli/routes.rb

@@ -0,0 +1,52 @@
+module Leadcli
+  module Routes
+
+    def create_endpoint(options)
+      [:post, create_url(options)]
+    end
+
+    def create_url(options={})
+      url = http_scheme.build(base_options.merge(path: create_path))
+      url.query = options[:query].map { |k,v| "#{k}=#{v}" }.join('&') if options[:query]
+      url.to_s
+    end
+
+    def delete_endpoint(options)
+      [:delete, delete_url(options)]
+    end
+
+    def delete_url(options)
+      url = http_scheme.build(base_options.merge(path: delete_path(options[:id])))
+      url.to_s
+    end
+
+    protected
+
+    def http_scheme
+      if Leadcli.configuration.secure
+        URI::HTTPS
+      else
+        URI::HTTP
+      end
+    end
+
+    def base_options
+      options = {}
+      options[:host] = Leadcli.configuration.host
+      options[:port] = Leadcli.configuration.port.to_i if Leadcli.configuration.port
+      options
+    end
+
+    def create_path
+      path = "/api/v1/leads"
+      path
+    end
+
+    def delete_path(lead_id)
+      path = "/api/v1/leads/#{lead_id}"
+      path
+    end
+
+  end
+end
+

data/lib/leadcli/version.rb

@@ -0,0 +1,4 @@
+module Leadcli
+  VERSION = "0.0.3"
+end
+

data/lib/leadcli.rb

@@ -0,0 +1,55 @@
+require "leadcli/version"
+require "leadcli/configuration"
+require "leadcli/routes"
+require "leadcli/api_caller"
+require "leadcli/api_call"
+require "leadcli/lead"
+
+module Leadcli
+  LOG_PREFIX = "** [Leadcli] "
+
+  class << self
+    attr_accessor :configuration
+
+    def log(message)
+      if logger
+        logger.info(LOG_PREFIX + message)
+      else
+        puts(LOG_PREFIX + message)
+      end
+    end
+
+    def debug(message)
+      if logger
+        logger.debug(LOG_PREFIX + message)
+      else
+        puts(LOG_PREFIX + message)
+      end
+    end
+
+    def logger
+      self.configuration && self.configuration.logger
+    end
+
+
+    #   @example
+    #    
+    #   Leadcli.configure do |config|
+    #     config.token = '1234567890abcdef'
+    #     config.host = 'localhost'
+    #     config.port = '3000'
+    #     config.logger = Rails.logger
+    #   end
+
+    def configure
+      self.configuration ||= Configuration.new
+      yield(configuration) if block_given?
+    end
+
+    def sync
+      return true
+    end
+  end
+
+end
+

data/spec/leadcli/api_call_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+class ApiCallerTest
+  include Leadcli::ApiCall
+end
+
+describe Leadcli::ApiCall do
+
+  it "creates an ApiCaller object and tells it to make the call" do
+    api_call_test = ApiCallerTest.new
+    api_call = double('api_call')
+    expect(api_call).to receive(:call).with(api_call_test)
+    expect(Leadcli::ApiCaller).to receive(:new).with(:endpoint, { foo: :bar }).and_return(api_call)
+    api_call_test.api_call(:endpoint, { foo: :bar })
+  end
+
+end

data/spec/leadcli/api_caller_spec.rb

@@ -0,0 +1,90 @@
+require 'spec_helper'
+
+
+describe Leadcli::ApiCaller do
+
+  describe "#new" do
+    it "stores the endpoint and options" do
+      api_caller = Leadcli::ApiCaller.new(:myendpoint, foo: :bar)
+      expect(api_caller.endpoint).to eq(:myendpoint)
+      expect(api_caller.options).to eq({ foo: :bar })
+    end
+  end
+
+  describe "#call" do
+    let(:api_caller) { with_configuration { Leadcli::ApiCaller.new(:test) } }
+    let(:url) { 'http://example.com/test' }
+    it "gets the method and url from the endpoint" do
+      expect(api_caller).to receive(:test_endpoint).with({}).and_return([:get, url])
+      api_caller.call(self)
+    end
+    it "passes through any url options" do
+      expect(api_caller).to receive(:test_endpoint).with({ query: { updated_at: '2013-07-19', foo: :bar }}).and_return([:get, url])
+      api_caller.options[:url_options] = { query: { updated_at: '2013-07-19', foo: :bar } }
+      expect(RestClient::Request).to receive(:execute).and_return(double('response', :code => 200))
+      api_caller.call(self)
+    end
+    describe "a GET request" do
+      it "make the call to the api" do
+        expect(api_caller).to receive(:test_endpoint).and_return([:get, url])
+        expect(RestClient::Request).to receive(:execute).with(hash_including(url: url, method: :get)).and_return(double('response', :code => 200))
+        api_caller.call(self)
+      end
+    end
+    describe "a POST request" do
+      it "make the call using :payload option as payload" do
+        expect(api_caller).to receive(:test_endpoint).and_return([:post, url])
+        api_caller.options[:payload] = 'test data'
+        expect(RestClient::Request).to receive(:execute).with(hash_including(:url => url, :payload => "test data", :method => :post)).and_return(double('response', :code => 200))
+        api_caller.call(self)
+      end
+    end
+  end
+
+  describe "call failed" do
+    let(:api_caller) { with_configuration { Leadcli::ApiCaller.new(:test) } }
+    let(:url) { 'url' }
+    let(:object) { double('calling object') }
+    before do
+      FakeWeb.register_uri(:get, url, :body => '', :status => [500, 'Internal Server Error'])
+      expect(api_caller).to receive(:test_endpoint).and_return([:get, url])
+    end
+
+    it "retries call, up to value of :max_connection_attempts option" do
+      api_caller.max_connection_attempts = 2
+      api_caller.call(object)
+      expect(api_caller.connection_attempts).to eq 2
+    end
+
+
+    {
+      304 => 'Not Modified',
+      404 => 'Resource Not Found',
+      500 => 'Internal Server Error',
+      # Work out when this could happen
+      # 501 => 'Not Implemented',
+      502 => 'Bad Gateway',
+      503 => 'Service Unavailable',
+      504 => 'Gateway Timeout',
+      # Work out when this could happen
+      # 505 => 'HTTP Version Not Supported',
+      # Work out when this could happen
+      # 506 => 'Variant Also Negotiates',
+      # Work out when this could happen
+      # 507 => 'Insufficient Storage', #WebDAV
+      # Work out when this could happen
+      # 509 => 'Bandwidth Limit Exceeded', #Apache
+      # Work out when this could happen
+      # 510 => 'Not Extended'
+    }.each do |code, reason|
+      it "fails when response is #{code} #{reason}" do
+        FakeWeb.register_uri(:get, url, :body => '', :status => [code.to_s, reason])
+        api_caller.options[:failure] = :fail
+        expect(object).to receive(:fail)
+        api_caller.call(object)
+      end
+    end
+  end
+
+end
+

data/spec/leadcli/configuration_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe Leadcli::Configuration do
+  let(:configuration) { Leadcli::Configuration.new }
+
+  it "sets the host by default" do
+    expect(configuration.host).to eq "new.eureo-tools.com"
+  end
+
+  it "allows the host to be overwritten" do
+    expect { configuration.host = 'test.host' }.to change(configuration, :host).to('test.host')
+  end
+
+  it "sets the port" do
+    expect { configuration.port = 1234 }.to change(configuration, :port).to(1234)
+  end
+
+  it "sets the token" do
+    expect { configuration.token = '123456789' }.to change(configuration, :token).to("123456789")
+  end
+
+end
+

data/spec/leadcli/lead_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+require 'json'
+
+describe Leadcli::Lead do
+  let(:params) { { subject: "Contact" }}
+  let(:lead) { Leadcli::Lead.new }
+
+  describe "#create" do
+    it "creates it" do
+      with_configuration(host: HOST, port: 3000, token: TOKEN) do
+        lead.create(params)
+        expect(lead.last_response).to match(/Contact/)
+      end
+    end
+    after(:each) do
+      lead_id = JSON.parse(lead.last_response)['id']
+      lead.delete(lead_id)
+    end
+  end
+
+  describe "#delete" do
+    context "when remote lead exists" do
+      it "delete it" do
+        with_configuration(host: HOST, port: 3000, token: TOKEN) do
+          lead.create(params)
+          created_lead_id = JSON.parse(lead.last_response)['id']
+          lead.delete(created_lead_id)
+
+          deleted_lead_id = JSON.parse(lead.last_response)['id']
+          expect(deleted_lead_id).to eq created_lead_id
+        end
+      end
+    end
+  end
+
+end
+

data/spec/leadcli/routes_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+class TestRoute
+  include Leadcli::Routes
+end
+
+describe Leadcli::Routes do
+  let!(:test_route) { TestRoute.new }
+  let(:config) { { host: 'test.host', port: 1234 } }
+
+  describe "create_endpoint" do
+    it "returns :post and the create url" do
+      options = { foo: :bar }
+      expect(test_route).to receive(:create_url).with(options).and_return('my_create_url')
+      expect(test_route.create_endpoint(options)).to eq([:post, 'my_create_url'])
+    end
+  end
+
+  describe "create_url" do
+    it "constructs the url from the configuration" do
+      with_configuration(config) do
+        expect(test_route.create_url).to eq "http://test.host:1234/api/v1/leads"
+      end
+    end
+    it "adds query parameters on to the url" do
+      with_configuration(config) do
+        url = test_route.create_url(query: { updated_at: '2013-07-19', foo: :bar })
+        expect(url).to match(/\?.*updated_at=2013-07-19/)
+        expect(url).to match(/\?.*foo=bar/)
+      end
+    end
+  end
+
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'leadcli'
+require 'fakeweb'
+
+HOST = 'localhost'
+TOKEN = "dea23643d95b70b6ac27a8003f9575659dc975737c266c56bcb20deed98aab3e3e8cd659752f180cf41a933473da89f92d8a5053c140ec07fe3b0deabee1c15b"
+
+def with_configuration(options = {})
+  Leadcli.configuration = nil
+  Leadcli.configure do |configuration|
+    options.each do |option, value|
+      configuration.send("#{option}=", value)
+    end
+  end
+  yield
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: leadcli
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Franck D'agostini
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Client gem for Leadheque server api
+email:
+- franck.dagostini@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- leadcli.gemspec
+- lib/leadcli.rb
+- lib/leadcli/api_call.rb
+- lib/leadcli/api_caller.rb
+- lib/leadcli/configuration.rb
+- lib/leadcli/lead.rb
+- lib/leadcli/rails.rb
+- lib/leadcli/routes.rb
+- lib/leadcli/version.rb
+- spec/leadcli/api_call_spec.rb
+- spec/leadcli/api_caller_spec.rb
+- spec/leadcli/configuration_spec.rb
+- spec/leadcli/lead_spec.rb
+- spec/leadcli/routes_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Client gem for Leadheque server api
+test_files:
+- spec/leadcli/api_call_spec.rb
+- spec/leadcli/api_caller_spec.rb
+- spec/leadcli/configuration_spec.rb
+- spec/leadcli/lead_spec.rb
+- spec/leadcli/routes_spec.rb
+- spec/spec_helper.rb