uber-estimates 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 941618ea4da01a2b65fe86af6096fb6c4e6704e4
+  data.tar.gz: 2708e1e4993dcc0d17884a22cc80e6594f6fa10c
+SHA512:
+  metadata.gz: c693625a0af68542bcb8d545e39210e5d1ab1433473d63e7db739f13ddaf5df3745198304345a6e56e98a81c26b87638d23a4ca34f72d6ec0b3ecf85a5e596bb
+  data.tar.gz: 9b3140bc7fe7efc76da9073bb116c2ea800533513003acbfb95b098ebe0b3ec41456117157e23c666bb3147e58a47505c242c6b3c2f6d5516fd849cca252bd49

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+test.rb

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 littleROR
+
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Bogdan
+
+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,118 @@
+# Uber::Estimates
+
+Uber Estimates is a small gem that wraps estimate endpoints from Uber API. Using this gem you will be able to get estimates about Uber rides nice and smooth.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'uber-estimates'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install uber-estimates
+
+## Usage
+
+### Gem configuration
+```ruby
+Uber::Estimates.configure do |config|
+  config.server_token = "your server token"
+end
+```
+
+### Getting price estimates
+To get price estimates you need to provide ```ruby :price ``` as estimations type, start point and end point coordinates, as below. More details at [Uber Docs](https://developer.uber.com/docs/rides/api/v1-estimates-price)
+```ruby
+Uber::Estimates.get_estimations(:price,
+  {start_latitude: 44.427587, start_longitude: 26.0987345,
+    end_latitude: 44.4599565, end_longitude: 26.0984328
+  }
+)
+```
+#### Response:
+```ruby
+#<Uber::Estimates::Response:0x0000000345cce0
+ @code=200,
+ @data=
+  [#<Uber::Estimates::ResponseTypes::Price:0x0000000345b9f8
+    @currency_code="RON",
+    @display_name="uberX",
+    @distance=3.24,
+    @duration=840,
+    @estimate="RON20-27",
+    @high_estimate=27,
+    @localized_display_name="uberX",
+    @low_estimate=20,
+    @product_id="1ca8d691-9f67-4bfb-9c57-cb727b52b7b7",
+    @surge_multiplier=2>,
+   #<Uber::Estimates::ResponseTypes::Price:0x0000000345b9d0
+    @currency_code="RON",
+    @display_name="uberSELECT",
+    @distance=3.24,
+    @duration=840,
+    @estimate="RON19-26",
+    @high_estimate=26,
+    @localized_display_name="uberSELECT",
+    @low_estimate=19,
+    @product_id="df439009-d1de-4a3c-9ead-9e0e6f0294b9",
+    @surge_multiplier=1.5>,
+   #<Uber::Estimates::ResponseTypes::Price:0x0000000345b9a8
+    @currency_code="RON",
+    @display_name="Uber Child Seat",
+    @distance=3.24,
+    @duration=840,
+    @estimate="RON20-24",
+    @high_estimate=24,
+    @localized_display_name="Uber Child Seat",
+    @low_estimate=20,
+    @product_id="99e0492a-acc1-412d-b650-48ed7fed9788",
+    @surge_multiplier=1.0>]>
+```
+
+### Getting time estimates
+To get time estimates you need to provide ```ruby :time ``` as estimations type, start point and end point coordinates, or a product_id. More details at [Uber Docs](https://developer.uber.com/docs/rides/api/v1-estimates-time)
+```ruby
+Uber::Estimates.get_estimations(:time,
+  {start_latitude: 44.427587, start_longitude: 26.0987345,
+    end_latitude: 44.4599565, end_longitude: 26.0984328
+  }
+)
+```
+or
+```ruby
+Uber::Estimates.get_estimations(:time,
+  {start_latitude: 44.427587, start_longitude: 26.0987345,
+    product_id: "99e0492a-acc1-412d-b650-48ed7fed9788"
+  }
+)
+```
+#### Response
+```ruby
+#<Uber::Estimates::Response:0x00000001cf2730
+ @code=200,
+ @data=
+  [#<Uber::Estimates::ResponseTypes::Time:0x00000001cf1790
+    @display_name="uberX",
+    @estimate=300,
+    @localized_display_name="uberX",
+    @product_id="1ca8d691-9f67-4bfb-9c57-cb727b52b7b7">,
+   #<Uber::Estimates::ResponseTypes::Time:0x00000001cf1768
+    @display_name="uberSELECT",
+    @estimate=420,
+    @localized_display_name="uberSELECT",
+    @product_id="df439009-d1de-4a3c-9ead-9e0e6f0294b9">]>
+```
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/uber-estimates/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/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "uber/estimates"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/uber/estimates.rb

@@ -0,0 +1,32 @@
+require "uber/estimates/version"
+require "uber/estimates/configuration"
+require "uber/estimates/type_exception"
+require "uber/estimates/bad_request_exception"
+require "uber/estimates/request"
+require "uber/estimates/response_types/base_response"
+require "uber/estimates/response_types/time"
+require "uber/estimates/response_types/price"
+require "uber/estimates/response"
+
+module Uber
+  module Estimates
+
+    TYPES = [:price, :time].freeze
+    class << self
+      attr_accessor :configuration
+    end
+
+    def self.configuration
+      @configuration ||= Configuration.new
+    end
+
+    def self.configure
+      yield(configuration)
+    end
+
+    def self.get_estimations(type, params)
+      raise TypeException.new('Type must be :price or :time') unless TYPES.include?(type)
+      response = Request.new(type, params).response
+    end
+  end
+end

data/lib/uber/estimates/bad_request_exception.rb

@@ -0,0 +1,6 @@
+module Uber
+  module Estimates
+    class BadRequestException < StandardError
+    end
+  end
+end

data/lib/uber/estimates/configuration.rb

@@ -0,0 +1,11 @@
+module Uber
+  module Estimates
+    class Configuration
+      attr_accessor :server_token
+
+      def initialize
+        @server_token = 'DEFAULT_TOKEN'
+      end
+    end
+  end
+end

data/lib/uber/estimates/request.rb

@@ -0,0 +1,29 @@
+require 'rest-client'
+module Uber
+  module Estimates
+    class Request
+      attr_reader :header, :type, :params
+      URLS = {time: 'https://api.uber.com/v1/estimates/time', price: 'https://api.uber.com/v1/estimates/price'}.freeze
+
+      def initialize(type, params)
+        @type = type
+        @params = params
+        @header = {Authorization: %Q[Token #{::Uber::Estimates.configuration.server_token}] }
+      end
+
+      def response
+        Response.new(type, raw_response)
+      end
+
+      private
+
+      def raw_response
+        begin
+          RestClient::Request.execute(method: :get, url: URLS[type], payload: params, headers: header)
+        rescue Exception => e
+          raise BadRequestException.new('Something went wrong on request. Please check params')
+        end
+      end
+    end
+  end
+end

data/lib/uber/estimates/response.rb

@@ -0,0 +1,22 @@
+require 'json'
+module Uber
+  module Estimates
+    class Response
+      attr_reader :code, :data
+
+      def initialize(type, raw_response)
+        @code = raw_response.code
+        if code >= 200 && code < 300
+          raw = JSON.parse(raw_response)
+          if type == :time
+            @data = raw['times'].map{ |raw_hash| ResponseTypes::Time.new(raw_hash) }
+          else
+            @data = raw['prices'].map{ |raw_hash| ResponseTypes::Price.new(raw_hash) }
+          end
+        else
+          @data = []
+        end
+      end
+    end
+  end
+end

data/lib/uber/estimates/response_types/base_response.rb

@@ -0,0 +1,15 @@
+module Uber
+  module Estimates
+    module ResponseTypes
+      class BaseResponse
+        attr_reader :localized_display_name, :display_name, :product_id
+
+        def initialize(raw_hash)
+          @localized_display_name = raw_hash['localized_display_name']
+          @display_name = raw_hash['display_name']
+          @product_id = raw_hash['product_id']
+        end
+      end
+    end
+  end
+end

data/lib/uber/estimates/response_types/price.rb

@@ -0,0 +1,19 @@
+module Uber
+  module Estimates
+    module ResponseTypes
+      class Price < BaseResponse
+        attr_reader :high_estimate, :low_estimate, :duration, :surge_multiplier, :currency_code, :distance, :estimate
+        def initialize(raw_hash)
+          super(raw_hash)
+          @high_estimate = raw_hash['high_estimate']
+          @low_estimate = raw_hash['low_estimate']
+          @duration = raw_hash['duration']
+          @surge_multiplier = raw_hash['surge_multiplier']
+          @currency_code = raw_hash['currency_code']
+          @distance = raw_hash['distance']
+          @estimate = raw_hash['estimate']
+        end
+      end
+    end
+  end
+end

data/lib/uber/estimates/response_types/time.rb

@@ -0,0 +1,14 @@
+module Uber
+  module Estimates
+    module ResponseTypes
+      class Time < BaseResponse
+        attr_reader :estimate
+
+        def initialize(raw_hash)
+          super(raw_hash)
+          @estimate = raw_hash['estimate']
+        end
+      end
+    end
+  end
+end

data/lib/uber/estimates/type_exception.rb

@@ -0,0 +1,6 @@
+module Uber
+  module Estimates
+    class TypeException < StandardError
+    end
+  end
+end

data/lib/uber/estimates/version.rb

@@ -0,0 +1,5 @@
+module Uber
+  module Estimates
+    VERSION = "0.1.0"
+  end
+end

data/uber-estimates.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'uber/estimates/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "uber-estimates"
+  spec.version       = Uber::Estimates::VERSION
+  spec.authors       = ["Bogdan"]
+  spec.email         = ["bogdan.timofte@hotmail.com"]
+
+  spec.summary       = %q{Small wraper for Uber API estimations endpoints }
+  spec.homepage      = "http://github.com"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'rest-client'
+  spec.add_dependency "activesupport", ">= 4.0.0"
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: uber-estimates
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bogdan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-04 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: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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: 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'
+description: 
+email:
+- bogdan.timofte@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/uber/estimates.rb
+- lib/uber/estimates/bad_request_exception.rb
+- lib/uber/estimates/configuration.rb
+- lib/uber/estimates/request.rb
+- lib/uber/estimates/response.rb
+- lib/uber/estimates/response_types/base_response.rb
+- lib/uber/estimates/response_types/price.rb
+- lib/uber/estimates/response_types/time.rb
+- lib/uber/estimates/type_exception.rb
+- lib/uber/estimates/version.rb
+- uber-estimates.gemspec
+homepage: http://github.com
+licenses:
+- MIT
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Small wraper for Uber API estimations endpoints
+test_files: []