onfleet 1.0.0

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 siddharth@vinsol.com
+
+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,114 @@
+# Onfleet
+
+Onfleet is an API wrapper for [Onfleet's APIs](http://docs.onfleet.com).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'onfleet'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install onfleet
+
+## Usage
+
+You can create an instance of the API wrapper:
+
+    onfleet = Onfleet::API.new("your_api_key")
+
+You can set `api_key`, `timeout`, `throws_exceptions`, `retry_if_fails` and `logger` globally:
+
+    Onfleet::API.api_key = "your_api_key"
+    Onfleet::API.timeout = 15
+    Onfleet::API.throws_exceptions = false
+    Onfleet::API.retry_if_fails = true
+    Onfleet::API.logger = Logger.new("#{Rails.root}/log/onfleet.log")
+
+
+For example, you could set the values above in an `initializer` file in your `Rails` app (e.g. your\_app/config/initializers/onfleet.rb).
+
+Assuming you've set an `api_key` on Onfleet, you can conveniently make API calls on the class itself:
+
+    Onfleet::API.tasks.all
+
+You can also set the environment variable `ONFLEET_API_KEY` and Onfleet will use it when you create an instance:
+
+    onfleet = Onfleet::API.new
+
+
+### Fetching Tasks
+
+For example, to fetch all the tasks of your organisation:
+
+    tasks = onfleet.tasks.all
+
+### Fetching Destinations
+
+Similarly, to fetch your destinations:
+
+    lists = onfleet.destinations.all
+
+Or, to fetch a task by id:
+
+    task = onfleet.tasks.find('task_id')
+
+Or, to delete a task by id:
+
+    task = onfleet.tasks.delete('task_id')
+
+
+Or, to update a task by id:
+
+    task = onfleet.tasks.delete(id: 'task_id', other_updating_params: value)
+
+    passing id to update any resource is necessory
+
+The above examples were for only task resource. Same way it can be used for other resources i.e. organization,
+admins, workers, teams, destinations, recipients, tasks, webhooks.
+
+### Setting timeouts
+
+Onfleet defaults to a 30 second timeout. You can optionally set your own timeout (in seconds) like so:
+
+    onfleet = Onfleet::API.new("your_api_key", {:timeout => 5})
+
+or
+
+    onfleet.timeout = 5
+
+### Error handling
+
+By default Onfleet will attempt to raise errors returned by the API automatically.
+
+If you set the `throws_exceptions` boolean attribute to false, for a given instance,
+then Onfleet will not raise exceptions. This allows you to handle errors manually. The
+APIs will return a Hash with two keys "message", a hash containing two keys 'message' and 'error'.
+'message' contains textual information about the error, 'error' the numeric code of the error,
+and "code", the name code of the error.
+
+If you rescue Onfleet::OnfleetError, you are provided with the error message itself as well as
+a `code` attribute that you can map onto the API's error list. The API docs list possible errors
+at the bottom of each page. Here's how you might do that:
+
+    begin
+      onfleet.tasks.all
+    rescue Onfleet::OnfleetError => e
+      # do something with e.message here
+      # do something wiht e.code here
+    end
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/onfleet/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

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

data/lib/onfleet.rb

@@ -0,0 +1,11 @@
+require "httparty"
+require "multi_json"
+require "onfleet/version"
+require "onfleet/api"
+require "onfleet/api_category"
+require "onfleet/onfleet_error"
+require "onfleet/api_logger"
+
+
+module Onfleet
+end

data/lib/onfleet/api.rb

@@ -0,0 +1,44 @@
+module Onfleet
+  class API
+
+    API_RESOURCES = %w{organization admins workers teams destinations recipients tasks webhooks}
+    attr_accessor :api_key, :api_endpoint, :timeout, :throws_exceptions
+
+    def initialize(api_key=nil, default_parameters={})
+      @api_key = api_key || self.class.api_key || ENV['ONFLEET_API_KEY']
+      @api_key = @api_key.strip if @api_key
+
+      @api_endpoint = default_parameters.delete(:api_endpoint) || self.class.api_endpoint
+      @timeout = default_parameters.delete(:timeout) || self.class.timeout
+      @throws_exceptions = default_parameters.has_key?(:throws_exceptions) ? default_parameters.delete(:throws_exceptions) : self.class.throws_exceptions
+
+      @default_params = default_parameters
+    end
+
+    def method_missing(method, *args)
+      if API_RESOURCES.include?(method.to_s)
+        api = APICategory.new(method.to_s, @api_key, @timeout, @throws_exceptions, @api_endpoint, @default_params)
+        api.api_endpoint = @api_endpoint if @api_endpoint
+        api
+      else
+        super
+      end
+    end
+
+    class << self
+      attr_accessor :api_key, :timeout, :throws_exceptions, :api_endpoint, :retry_if_fails, :max_try_count, :logger
+
+      def logger
+        @logger || Onfleet::APILogger.new
+      end
+
+      def method_missing(sym, *args, &block)
+        if API_RESOURCES.include?(sym.to_s)
+          new(self.api_key, {:api_endpoint => self.api_endpoint, :timeout => self.timeout, :throws_exceptions => self.throws_exceptions}).send(sym, *args, &block)
+        else
+          super
+        end
+      end
+    end
+  end
+end

data/lib/onfleet/api_category.rb

@@ -0,0 +1,127 @@
+require 'onfleet/api'
+
+module Onfleet
+  class APICategory
+    include HTTParty
+    format :plain
+    default_timeout 30
+
+    attr_accessor :category_name, :api_key, :api_endpoint, :timeout, :throws_exceptions, :default_params
+
+    def initialize(category_name, api_key, timeout, throws_exceptions, api_endpoint, default_params)
+      @category_name = category_name
+      @api_key = api_key
+      @api_endpoint = api_endpoint || get_api_endpoint
+      @default_params = default_params
+      @throws_exceptions = throws_exceptions
+      @timeout = timeout
+      @try_count = 0
+
+      set_instance_defaults
+    end
+
+    def call(method, params = {})
+      ensure_api_key
+      set_api_url
+      params = @default_params.merge(params)
+      if (response = send_api_request(method, params))
+        parsed_response = response.parsed_response
+        raise_error_with_message(parsed_response) if should_raise_for_response?(response.code)
+        parsed_response
+      end
+    end
+
+    def send_api_request(method, params)
+      begin
+        Onfleet::API.logger.info "Try Count: #{ @try_count } Start Onfleet API Request #{ @api_url }"
+        response = HTTParty.send(method, @api_url, :body => MultiJson.dump(params), basic_auth: { username: @api_key }, :timeout => @timeout)
+        Onfleet::API.logger.info "Try Count: #{ @try_count } End Onfleet API Request Response Code: #{response.code}"
+        raise OnfleetError, 'Retrying TooManyRequestsError Response Code: 429' if (response.code == 429 && should_retry_if_fails?)
+        return response
+      rescue StandardError => e
+        Onfleet::API.logger.error "ERROR:#{e} #{e.message}"
+        if should_retry_if_fails?
+          @try_count += 1
+          call(method, params)
+        else
+          raise e
+        end
+      end
+      return nil
+    end
+
+    def set_api_url
+      @api_url = @api_endpoint + @category_name
+    end
+
+    def raise_error_with_message(parsed_response={})
+      parsed_response['message'] ||= {}
+      error = OnfleetError.new(parsed_response['message']['message'])
+      error.code = parsed_response['message']['error']
+      error.name = parsed_response['code']
+      Onfleet::API.logger.error "ERROR:#{error.name} #{error.message} ERROR CODE: #{error.code}"
+      raise error
+    end
+
+    def find(id)
+      self.category_name = "#{category_name}/#{id}"
+      call(:get)
+    end
+
+    def all
+      call(:get)
+    end
+
+    def create(args={})
+      call(:post, args)
+    end
+
+    def delete(id)
+      self.category_name = "#{category_name}/#{id}"
+      call(:delete)
+    end
+
+    def update(args={})
+      if id = args.delete(:id)
+        self.category_name = "#{category_name}/#{id}"
+        call(:put, args)
+      else
+        Onfleet::API.logger.error "ERROR: Please give id of #{@category_name} for update"
+        raise OnfleetError, "Please give id of #{@category_name} for update"
+      end
+    end
+
+    def set_instance_defaults
+      @timeout = (API.timeout || 30) if @timeout.nil?
+      @throws_exceptions = API.throws_exceptions if @throws_exceptions.nil?
+      @throws_exceptions = true if @throws_exceptions.nil?
+    end
+
+    def api_key=(value)
+      @api_key = value.strip if value
+    end
+
+    def should_raise_for_response?(response_code)
+      @throws_exceptions && (400..500).include?(response_code)
+    end
+
+    def should_retry_if_fails?
+      Onfleet::API.retry_if_fails && (@try_count < (Onfleet::API.max_try_count || 5))
+    end
+
+    def get_api_endpoint
+      "https://onfleet.com/api/v2/"
+    end
+
+
+
+    private
+
+    def ensure_api_key
+      unless @api_key
+        Onfleet::API.logger.error "ERROR: You must set an api_key prior to making a call"
+        raise Onfleet::OnfleetError, "You must set an api_key prior to making a call"
+      end
+    end
+  end
+end

data/lib/onfleet/api_logger.rb

@@ -0,0 +1,19 @@
+module Onfleet
+  class APILogger
+    def info(msg)
+      $stdout.puts msg
+    end
+    def warn(msg)
+      $stdout.puts msg
+    end
+    def error(msg)
+      $stdout.puts msg
+    end
+    def debug(msg)
+      $stdout.puts msg
+    end
+    def fatal(msg)
+      $stdout.puts msg
+    end
+  end
+end

data/lib/onfleet/onfleet_error.rb

@@ -0,0 +1,5 @@
+module Onfleet
+  class OnfleetError < StandardError
+    attr_accessor :code, :name
+  end
+end

data/lib/onfleet/version.rb

@@ -0,0 +1,3 @@
+module Onfleet
+  VERSION = "1.0.0"
+end

data/onfleet.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'onfleet/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "onfleet"
+  spec.version       = Onfleet::VERSION
+  spec.authors       = ["Siddharth Sharma"]
+  spec.email         = ["siddharth@vinsol.com"]
+  spec.summary       = %q{Write a short summary. Required.}
+  spec.description   = %q{Write a longer description. Optional.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  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_dependency "httparty"
+  spec.add_dependency "multi_json"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: onfleet
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Siddharth Sharma
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Write a longer description. Optional.
+email:
+- siddharth@vinsol.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/onfleet.rb
+- lib/onfleet/api.rb
+- lib/onfleet/api_category.rb
+- lib/onfleet/api_logger.rb
+- lib/onfleet/onfleet_error.rb
+- lib/onfleet/version.rb
+- onfleet.gemspec
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Write a short summary. Required.
+test_files: []