foxtrot-client 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 97cd0d96398916ec13f13e9d34c2fe9e1034ed37
+  data.tar.gz: d940719a600210e030be9b6d3cf28e38185bb311
+SHA512:
+  metadata.gz: 752d0d4226b4b24665dadcd3e4b355c506b45e790f812d0cbebd12357abd54eeb76d7f633248be5ee47c2d001a2400605df1c1bfdc71407c551eb912e4b0a26a
+  data.tar.gz: 7ca3c3bdbeabc4151da87eaf5d7fdb3be46766a3324999073e483ef34ecd649658458939f67502daf3573da17ddd8713887e0b9c6e97e57b77a1007c5b6b4f9c

data/.gitignore

@@ -0,0 +1,41 @@
+# Created by https://www.gitignore.io
+
+### Ruby ###
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+*.pid
+
+gems/

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,31 @@
+PATH
+  remote: .
+  specs:
+    foxtrot-client (0.0.1)
+      addressable (~> 2.3.6)
+      rest_client (~> 1.7.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.3.6)
+    coderay (1.1.0)
+    method_source (0.8.2)
+    netrc (0.7.9)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (10.4.2)
+    rest_client (1.7.3)
+      netrc (~> 0.7.7)
+    slop (3.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.6)
+  foxtrot-client!
+  pry
+  rake

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Yasyf Mohamedali, Foxtrot Systems
+
+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,41 @@
+# Foxtrot Ruby Client Library
+
+This is the Ruby client library for interacting with the Foxtrot API. The only endpoint currently exposed is the route optimization endpoint (`Foxtrot::Client.optimize!`).
+
+In order to make requests, you need a valid API key. Your API key can be found at the bottom of any page in the [Foxtrot web app](http://app.foxtrot.io/).
+
+## Installation
+
+`gem install foxtrot-client`
+
+## Usage
+
+```ruby
+data = {
+  file_url: "https://www.domain.io/your_file.xlsx",
+  file_name: "your_file.xlsx",
+  geocode: "false",
+  stop_name: "Customer",
+  lat: "Lat",
+  lng: "Long",
+  load: "Load",
+  service_time: "Service Time",
+  time_window: "Time Window",
+  extra_info: "Contact Info",
+  date_starting: "1407712069593",
+  warehouse: "77 Massachusetts Ave, Cambridge MA",
+  num_drivers: 1,
+  num_avg_service_time: 10,
+  float_fuel_cost: 3.56,
+  float_driver_wage: 6.01,
+  float_mpg: 8.32
+}
+
+api_key = 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'
+
+require 'foxtrot'
+fox = Foxtrot::Client.new api_key
+
+resp = fox.optimize!(data).poll_and_block!
+result = resp.get_result
+```

data/Rakefile

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

data/foxtrot-client.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'foxtrot/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "foxtrot-client"
+  spec.version       = Foxtrot::VERSION
+  spec.authors       = ["Yasyf Mohamedali"]
+  spec.email         = ["yasyf@foxtrot.io"]
+  spec.summary       = "Foxtrot Ruby Client Library"
+  spec.homepage      = "https://github.com/FoxtrotSystems/api-client-ruby"
+  spec.license       = 'MIT'
+  spec.required_ruby_version = ">= 2.0"
+
+  spec.description   =  File.read('README.md')
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "pry"
+  spec.add_runtime_dependency 'rest_client', '~> 1.7', '>= 1.7.2'
+  spec.add_runtime_dependency 'addressable', '~> 2.3', '>= 2.3.6'
+end

data/lib/foxtrot.rb

@@ -0,0 +1 @@
+require "foxtrot/client"

data/lib/foxtrot/client.rb

@@ -0,0 +1,66 @@
+require 'addressable/uri'
+require 'json'
+require 'rest_client'
+require 'foxtrot/required_fields'
+require 'foxtrot/response'
+require 'foxtrot/errors'
+
+module Foxtrot
+  class Client
+
+    class << self
+      attr_accessor :host, :ssl
+    end
+
+    @host = 'app.foxtrot.io'
+    @ssl = true
+
+    def initialize(api_key, version='v1')
+      @api_key = api_key
+      @version = version
+      @headers = {:content_type => :json, :accept => :json}
+    end
+
+    def poll!(endpoint, txid, args={})
+      resp = get_request(endpoint, {txid: txid})
+      Foxtrot::Response::Response.response_for(endpoint, resp, self)
+    end
+
+    def optimize!(data, args={})
+      check_required 'optimize', data
+      resp = post_request 'optimize', data, args
+      Foxtrot::Response::Response.response_for('optimize', resp, self)
+    end
+
+    private
+
+    def check_required(endpoint, data)
+      required = Foxtrot::RequiredFields.const_get(endpoint.upcase)
+      data = data.inject({}){ |h, (k,v)| h.merge({k.to_sym => v}) }
+      required.each do |field|
+        unless data.include?(field)
+          raise Foxtrot::Errors::ParameterError.new(field)
+        end
+      end
+    end
+
+    def build_url(endpoint, args)
+      uri = Addressable::URI.new
+      uri.host = self.class.host
+      uri.scheme = self.class.ssl ? 'https' : 'http'
+      uri.query_values = args.merge({key: @api_key})
+      uri.path = "/api/#{@version}/#{endpoint}"
+      uri.to_s
+    end
+
+    def get_request(endpoint, args)
+      resp = RestClient.get build_url(endpoint, args), @headers
+      JSON.load resp
+    end
+
+    def post_request(endpoint, data, args)
+      resp = RestClient.post build_url(endpoint, args), data.to_json, @headers
+      JSON.load resp
+    end
+  end
+end

data/lib/foxtrot/errors.rb

@@ -0,0 +1,24 @@
+module Foxtrot
+  module Errors
+    class FoxtrotError < StandardError
+    end
+
+    class ParameterError < FoxtrotError
+      def initialize(param)
+        @param = param
+        super "Missing Parameter: #{param}"
+      end
+    end
+
+    class APIResponseError < FoxtrotError
+    end
+
+    class APITimeoutError < FoxtrotError
+      def initialize(count)
+        @count = count
+        super "Request timed out after #{count} seconds."
+      end
+    end
+
+  end
+end

data/lib/foxtrot/required_fields.rb

@@ -0,0 +1,7 @@
+module Foxtrot
+  module RequiredFields
+    OPTIMIZE = [:file_url, :file_name, :geocode, :stop_name, :date_starting,
+                :warehouse, :num_drivers, :num_avg_service_time, :float_fuel_cost,
+                :float_driver_wage, :float_mpg]
+  end
+end

data/lib/foxtrot/response.rb

@@ -0,0 +1,110 @@
+require 'foxtrot/errors'
+
+module Foxtrot
+  module Response
+    class Response
+      def initialize(endpoint, resp, api_instance)
+        @endpoint = endpoint
+        @resp = resp
+        @api_instance = api_instance
+      end
+
+      def poll_and_block!(interval=1, timeout=60)
+        count = 0
+        instance = self
+        while !instance.complete?
+          instance = instance.poll!
+          sleep interval
+          count += interval
+          if count > timeout
+            raise Foxtrot::Errors::APITimeoutError.new(count)
+          end
+        end
+        instance
+      end
+
+      def self.response_for(endpoint, resp, api_instance)
+        case resp['status']
+        when 'pending'
+          PendingResponse.new(endpoint, resp, api_instance)
+        when 'success'
+          SuccessResponse.new(endpoint, resp, api_instance)
+        else
+          ErrorResponse.new(endpoint, resp, api_instance)
+        end
+      end
+    end
+
+    class ErrorResponse < Response
+      def initialize(endpoint, resp, api_instance)
+        super
+        @message = resp['message']
+        @exception = Foxtrot::Errors::APIResponseError.new @message
+        raise @exception
+      end
+
+      def complete?
+        true
+      end
+
+      def poll!
+        raise @exception
+      end
+
+      def get_result
+        nil
+      end
+
+      def to_s
+        "ErrorResponse (#{@message})"
+      end
+    end
+
+    class PendingResponse < Response
+      def initialize(endpoint, resp, api_instance)
+        super
+        @txid = resp['txid']
+      end
+
+      def complete?
+        false
+      end
+
+      def poll!
+        @api_instance.poll! @endpoint, @txid
+      end
+
+      def get_result
+        nil
+      end
+
+      def to_s
+        "PendingResponse (#{@txid})"
+      end
+    end
+
+    class SuccessResponse < Response
+      def initialize(endpoint, resp, api_instance)
+        super
+        @txid = resp['txid']
+        @data = resp['response']['api_data']
+      end
+
+      def complete?
+        true
+      end
+
+      def poll!
+        self
+      end
+
+      def get_result
+        @data
+      end
+
+      def to_s
+        "SuccessResponse (#{@txid})"
+      end
+    end
+  end
+end

data/lib/foxtrot/version.rb

@@ -0,0 +1,3 @@
+module Foxtrot
+  VERSION = "0.0.4"
+end

metadata

@@ -0,0 +1,180 @@
+--- !ruby/object:Gem::Specification
+name: foxtrot-client
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- Yasyf Mohamedali
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: pry
+  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: rest_client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.2
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.6
+description: |
+  # Foxtrot Ruby Client Library
+
+  This is the Ruby client library for interacting with the Foxtrot API. The only endpoint currently exposed is the route optimization endpoint (`Foxtrot::Client.optimize!`).
+
+  In order to make requests, you need a valid API key. Your API key can be found at the bottom of any page in the [Foxtrot web app](http://app.foxtrot.io/).
+
+  ## Installation
+
+  `gem install foxtrot-client`
+
+  ## Usage
+
+  ```ruby
+  data = {
+    file_url: "https://www.domain.io/your_file.xlsx",
+    file_name: "your_file.xlsx",
+    geocode: "false",
+    stop_name: "Customer",
+    lat: "Lat",
+    lng: "Long",
+    load: "Load",
+    service_time: "Service Time",
+    time_window: "Time Window",
+    extra_info: "Contact Info",
+    date_starting: "1407712069593",
+    warehouse: "77 Massachusetts Ave, Cambridge MA",
+    num_drivers: 1,
+    num_avg_service_time: 10,
+    float_fuel_cost: 3.56,
+    float_driver_wage: 6.01,
+    float_mpg: 8.32
+  }
+
+  api_key = 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'
+
+  require 'foxtrot'
+  fox = Foxtrot::Client.new api_key
+
+  resp = fox.optimize!(data).poll_and_block!
+  result = resp.get_result
+  ```
+email:
+- yasyf@foxtrot.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- foxtrot-client.gemspec
+- lib/foxtrot.rb
+- lib/foxtrot/client.rb
+- lib/foxtrot/errors.rb
+- lib/foxtrot/required_fields.rb
+- lib/foxtrot/response.rb
+- lib/foxtrot/version.rb
+homepage: https://github.com/FoxtrotSystems/api-client-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.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: Foxtrot Ruby Client Library
+test_files: []