uber-ruby 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a8866e2f3a8c74e73cfda4a46343907b425d4b82
-  data.tar.gz: 3d85f87c54001e2ea560f38eff5d3b4b798091ae
+  metadata.gz: c4c9bf4cb4b8f0ced763b3702bb943a90ae36327
+  data.tar.gz: 2e123aa2989f454b0f0e3e88a908e11e38aa7c95
 SHA512:
-  metadata.gz: 91e44a3617b586a97339842a742512ea22e2e1ecb399eb0d8774e90a9044158f64f18caee6898dd2be8a769f208aee16a9ee442da708b9df3db7666617278879
-  data.tar.gz: cbd1f1c0d8f6831e86ec7c69f3e44891358cf05d8c84f7d760d0913b9827aea2003b44a3b62af41c9339a99f3a039846aecff74d4e92e44ee81ec90d479670c6
+  metadata.gz: c9ec68f21a3ebb754e11df5d7559d222dfcb41552578697583110299dfa1c1130c45bf66afc23ca40bb8d6780fbd5babcc04f543414d0267d8a1a814dadd7d82
+  data.tar.gz: d3c849532fe23d3f62ac85493fb4f92f1c6747c7aee8c88afe89f8162f316419960ffd376b643d7c089c659ca103e832e3d2b24002c2a0cc4001384c52dae9c0

data/README.md

@@ -26,6 +26,22 @@ client = Uber::Client.new do |config|
 end
 ```
 
+### Sandbox mode
+The Uber API Sandbox provides development endpoints for testing the functionality of an application without making calls to the production Uber platform. All requests made to the Sandbox environment will be ephemeral.
+
+```ruby
+client = Uber::Client.new do |config|
+  config.server_token  = "YOUR_SERVER_TOKEN"
+  config.client_id     = "YOUR_CLIENT_ID"
+  config.client_secret = "YOUR_CLIENT_SECRET"
+  config.sandbox       = true
+end
+# More info here https://developer.uber.com/docs/sandbox#section-product-types
+```
+
+## Debug mode
+Add `config.debug = true` to log HTTP request-response headers while making API requests.
+
 ## Usage
 
 ### Request Products
@@ -166,9 +182,87 @@ end
 client.trip_cancel 'request_id'
 ```
 
+### Retrieve addresses
+Retrieves address information of _home_ or _work_.
+
+```ruby
+client = Uber::Client.new do |config|
+  config.client_id     = "YOUR_CLIENT_ID"
+  config.client_secret = "YOUR_CLIENT_SECRET"
+  config.bearer_token  = "USER_ACCESS_TOKEN"
+end
+
+place = client.places 'home'
+place.address #=> retuns fully qualified address of location
+```
+
+### Update addresses
+Updates address information of _home_ or _work_.
+```ruby
+client = Uber::Client.new do |config|
+  config.client_id     = "YOUR_CLIENT_ID"
+  config.client_secret = "YOUR_CLIENT_SECRET"
+  config.bearer_token  = "USER_ACCESS_TOKEN"
+end
+
+place = client.place_update 'home', 'my address'
+place.address #=> retuns fully qualified address of location
+```
+
+### Retrieve a reminder
+This allows you to get the status of an existing ride reminder.    
+**Note**: It only supports _server_token_. 
+```ruby
+client = Uber::Client.new do |config|
+  config.client_id     = "YOUR_CLIENT_ID"
+  config.client_secret = "YOUR_CLIENT_SECRET"
+  client.server_token  = "YOUR_SERVER_TOKEN"
+end
+client.reminder 'reminder_id'
+#=> Uber::Reminder
+```
+
+### Add a reminder
+This allows developers to set a reminder for a future trip. You can pass object of `Time` or _unixtime_ in `reminder_time` and `event.time`.
+```ruby
+reminder = client.add_reminder({reminder_time: Time.local(2016, 9, 8, 23, 23, 23),
+                                phone_number: '+91-9999999999',
+                                trip_branding: {link_text: 'My first reminder'},
+                                event: {time: Time.now + 234234},
+                                reminder_id: 'rem1' })
+reminder.event.time
+#=> 2016-09-11 11:02:06 UTC
+reminder.reminder_time
+#=> 2016-09-08 17:53:23 UTC
+reminder.reminder_status
+#=> "pending"
+```
+
+### Update a reminder
+This allows you to update an existing reminder.
+```ruby
+reminder = client.add_reminder('rem1', {reminder_time: Time.local(2016, 9, 10, 23, 23, 23),
+                                        phone_number: '+91-9999999999',
+                                        trip_branding: {link_text: 'My edited reminder'},
+                                        event: {time: Time.now + 234234},
+                                        reminder_id: 'rem1' })
+reminder.trip_branding.link_text
+#=> "My edited reminder"
+
+```
+
+### Delete a reminder
+This allows you to remove any reminder in the pending state from being sent.
+```ruby
+reminder.delete_reminder 'rem1'
+#=> Uber::Reminder
+```
+
+
 ## Contributors
 
 * [Arun Thampi](https://github.com/arunthampi)
+* [Ankur Goel](https://github.com/AnkurGel)
 
 ## Contributing
 

data/lib/uber/api.rb

@@ -4,7 +4,9 @@ require 'uber/api/time_estimates'
 require 'uber/api/activities'
 require 'uber/api/me'
 require 'uber/api/promotions'
+require 'uber/api/reminders.rb'
 require 'uber/api/requests'
+require 'uber/api/places'
 
 module Uber
   module API
@@ -15,6 +17,8 @@ module Uber
     include Uber::API::Activities
     include Uber::API::Me
     include Uber::API::Promotions
+    include Uber::API::Places
+    include Uber::API::Reminders
     include Uber::API::Requests
   end
 end

data/lib/uber/api/places.rb

@@ -0,0 +1,19 @@
+require 'uber/arguments'
+require 'uber/api_request'
+require 'uber/models/place'
+
+module Uber
+  module API
+    module Places
+      def place(place_id)
+        perform_with_object(:get, "/v1/places/#{place_id}", {}, Place)
+      end
+
+      def place_update(place_id, address)
+        perform_with_object(:put, "/v1/places/#{place_id}", {address: address}, Place)
+      end
+
+      alias_method :place_detail, :place
+    end
+  end
+end

data/lib/uber/api/reminders.rb

@@ -0,0 +1,43 @@
+require 'uber/arguments'
+require 'uber/api_request'
+require 'uber/models/reminder'
+
+module Uber
+  module API
+    module Reminders
+
+      def reminder(reminder_id)
+        perform_with_object(:get, "/v1/reminders/#{reminder_id}", {}, Reminder)
+      end
+
+      def add_reminder(*args)
+        arguments = sanitize_time(Uber::Arguments.new(args))
+        perform_with_object(:post, "/v1/reminders", arguments.options, Reminder)
+      end
+
+      def update_reminder(reminder_id, *args)
+        arguments = sanitize_time(Uber::Arguments.new(args))
+        perform_with_object(:patch, "/v1/reminders/#{reminder_id}", arguments.options, Reminder)
+      end
+
+      def delete_reminder(reminder_id)
+        perform_with_object(:delete, "/v1/reminders/#{reminder_id}", {}, Reminder)
+      end
+
+      alias_method :reminder_detail, :reminder
+
+      private
+      def sanitize_time(arguments)
+        options = arguments.options
+        options[:reminder_time] = to_unix_time(options[:reminder_time])
+        options[:event][:time] = to_unix_time(options[:event][:time]) if options[:event]
+        arguments
+      end
+
+      def to_unix_time(attr)
+        attr && attr.instance_of?(::Time) ? attr.to_i : attr
+      end
+
+    end
+  end
+end

data/lib/uber/client.rb

@@ -12,6 +12,7 @@ module Uber
     attr_accessor :server_token, :client_id, :client_secret
     attr_accessor :bearer_token
     attr_accessor :sandbox
+    attr_accessor :debug
 
     attr_writer :connection_options, :middleware
     ENDPOINT = 'https://api.uber.com'
@@ -59,6 +60,7 @@ module Uber
         faraday.request :url_encoded
         # Parse JSON response bodies
         faraday.response :parse_json
+        faraday.response :logger if self.debug
         # Use instrumentation if available
         faraday.use :instrumentation if defined?(FaradayMiddleware::Instrumentation)
         # Set default HTTP adapter
@@ -90,6 +92,12 @@ module Uber
       request(:delete, path, params, headers)
     end
 
+    # Perform an HTTP PATCH request
+    def patch(path, params={})
+      headers = params.values.any? { |value| value.respond_to?(:to_io) } ? request_headers(:post, path, params, {}) : request_headers(:patch, path, params)
+      request(:patch, path, params.to_json, headers)
+    end
+
     # @return [Boolean]
     def bearer_token?
       !!bearer_token

data/lib/uber/error.rb

@@ -78,6 +78,9 @@ module Uber
 
     class ClientError < self; end
 
+    # Raised when Uber requests are timed-out
+    class RequestTimeout < ClientError; end
+
     class ConfigurationError < ::ArgumentError; end
 
     # Raised when Uber returns the HTTP status code 400

data/lib/uber/models/place.rb

@@ -0,0 +1,5 @@
+module Uber
+  class Place < Base
+    attr_accessor :address
+  end
+end

data/lib/uber/models/product.rb

@@ -1,5 +1,10 @@
 module Uber
   class Product < Base
-    attr_accessor :product_id, :description, :display_name, :capacity, :image
+    attr_accessor :product_id, :description, :display_name, :capacity, :image,
+                  :cash_enabled, :shared, :price_details
+
+    [:cash_enabled, :shared].each do |m|
+      define_method("#{m}?") { instance_variable_get("@#{m}") }
+    end
   end
 end

data/lib/uber/models/reminder.rb

@@ -0,0 +1,30 @@
+module Uber
+  class Reminder < Base
+    attr_accessor :event, :product_id, :reminder_id, :reminder_time, :reminder_status, :trip_branding
+
+    def event=(value)
+      @event = value && Event.new(value)
+    end
+
+    def trip_branding=(value)
+      @trip_branding = value && TripBranding.new(value)
+    end
+
+    def reminder_time
+      @reminder_time && ::Time.at(@reminder_time)
+    end
+
+    class Event < Base
+      attr_accessor :name, :location, :latitude, :longitude, :time
+
+      def time
+        @time && ::Time.at(@time)
+      end
+    end
+
+    class TripBranding < Base
+      attr_accessor :link_text, :partner_deeplink
+    end
+  end
+
+end

data/lib/uber/models/user.rb

@@ -1,5 +1,9 @@
 module Uber
   class User < Base
-    attr_accessor :first_name, :last_name, :email, :picture, :promo_code, :uuid
+    attr_accessor :first_name, :last_name, :email, :picture, :promo_code, :mobile_verified, :uuid
+
+    def mobile_verified?
+      !!self.mobile_verified
+    end
   end
 end

data/lib/uber/version.rb

@@ -1,8 +1,8 @@
 module Uber
   class Version
     MAJOR = 0
-    MINOR = 6
-    PATCH = 1
+    MINOR = 7
+    PATCH = 0
 
     class << self
       # @return [String]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: uber-ruby
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Dingding Ye
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-05 00:00:00.000000000 Z
+date: 2016-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -108,9 +108,11 @@ files:
 - lib/uber/api.rb
 - lib/uber/api/activities.rb
 - lib/uber/api/me.rb
+- lib/uber/api/places.rb
 - lib/uber/api/price_estimates.rb
 - lib/uber/api/products.rb
 - lib/uber/api/promotions.rb
+- lib/uber/api/reminders.rb
 - lib/uber/api/requests.rb
 - lib/uber/api/time_estimates.rb
 - lib/uber/api_request.rb
@@ -121,9 +123,11 @@ files:
 - lib/uber/models/activity.rb
 - lib/uber/models/estimate.rb
 - lib/uber/models/map.rb
+- lib/uber/models/place.rb
 - lib/uber/models/price.rb
 - lib/uber/models/product.rb
 - lib/uber/models/promotion.rb
+- lib/uber/models/reminder.rb
 - lib/uber/models/request.rb
 - lib/uber/models/time.rb
 - lib/uber/models/user.rb