rlyft 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5387bcd03848cc82eb4d43de5355a830825ab252
-  data.tar.gz: 930f6d562dbd1f1df4ffc8087da655344ccab834
+  metadata.gz: e30ad205ab2786789b29d6628a7e019b728c4004
+  data.tar.gz: 52ef840de85b6ab593e847be586a2293dc0c404c
 SHA512:
-  metadata.gz: 01dd62c99f9eb34162042a571c39c2a96120d4a2a2dffa3652dd918191be1081b9ac842f7ca31e733de275faf449574ff682d79982b2d93a481b613648e66240
-  data.tar.gz: 93d6f9caac191b93c2ded4fd858b824b3f15d58f747dd9979ae9fdab4d5c8b18e1be477d83912d9da2e04b461896c1d44ed87bd1cb218e5d3902fcd7293fc4b4
+  metadata.gz: 7547028ed225fb54fa166120af7901097552b5ea6d5e538389197b63414a45cb4f58d9c75e56d458511d6cb021cdcd3360d576192c9ed7ae5d6c505f6e25cc21
+  data.tar.gz: 5b9742fff70a7d6e6c47017edda5f35ba3b83eb56cd3726fe7a9139bf9fa0eb8bbe96bbba8075e45843262db6ec0b8bc0e1bccaa60896bc6a858cf05b5912da3

data/lib/lyft/api/availability/cost.rb

@@ -1,6 +1,20 @@
 module Lyft
   module Api
     module Availability
+      ##
+      # Get Lyft costs
+      #
+      # @example
+      #     client.cost start_lat: 37.7772,
+      #                 start_lng: -122.4233,
+      #                 end_lat: 37.7972,
+      #                 end_lng: -122.4533
+      #
+      # @param [Hash] args
+      # @option args [Float] :start_lat The latitude of starting point. (*required*)
+      # @option args [Float] :start_lng The longitude of starting point. (*required*)
+      # @option args [Float] :end_lat The latitude of the end point. (*required*)
+      # @option args [Float] :end_lng The longitude of the end point. (*required*)
       def cost(args = {})
         uri = Lyft.endpoint('/v1/cost')
         options = {

data/lib/lyft/api/availability/eta.rb

@@ -1,6 +1,16 @@
 module Lyft
   module Api
     module Availability
+      ##
+      # Get eta for lyft driver to reach location
+      #
+      # @example
+      #     client.eta lat: 37.7772,
+      #                lng: -122.4233
+      #
+      # @param [Hash] args
+      # @option args [Float] :lat The latitude of pickup. (*required*)
+      # @option args [Float] :lng The longitude of pickup. (*required*)
       def eta(args = {})
         uri = Lyft.endpoint('/v1/eta')
         options = {

data/lib/lyft/api/availability/nearby_drivers.rb

@@ -1,6 +1,16 @@
 module Lyft
   module Api
     module Availability
+      ##
+      # Get positions of nearby drivers
+      #
+      # @example
+      #     client.nearby_drivers lat: 37.7772,
+      #                           lng: -122.4233
+      #
+      # @param [Hash] args
+      # @option args [Float] :lat The latitude of pickup. (*required*)
+      # @option args [Float] :lng The longitude of pickup. (*required*)
       def nearby_drivers(args = {})
         uri = Lyft.endpoint('/v1/drivers')
         options = {

data/lib/lyft/api/availability/ride_types.rb

@@ -1,6 +1,16 @@
 module Lyft
   module Api
     module Availability
+      ##
+      # Get available lyft ride types
+      #
+      # @example
+      #     client.ride_types lat: 37.7772,
+      #                       lng: -122.4233
+      #
+      # @param [Hash] args
+      # @option args [Float] :lat The latitude of pickup. (*required*)
+      # @option args [Float] :lng The longitude of pickup. (*required*)
       def ride_types(args = {})
         uri = Lyft.endpoint('/v1/ridetypes')
         options = {

data/lib/lyft/api/oauth/public_token.rb

@@ -1,6 +1,11 @@
 module Lyft
   module Api
     module Oauth
+      ##
+      # Retrieve public oauth token.
+      #
+      # @todo Use same token until expires
+      #
       def public_token(renew = false)
         # return @public_token unless @public_token.nil? && !renew
 

data/lib/lyft/client.rb

@@ -1,4 +1,10 @@
 module Lyft
+  ##
+  # Client for making Lyft api requests
+  #
+  # @attr [String] client_id The client id for lyft app.
+  # @attr [String] client_secret The client secret for lyft app.
+  #
   class Client
     include Api::Oauth
     include Api::Availability

data/lib/lyft/version.rb

@@ -1,3 +1,3 @@
 module Lyft
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lyft.gemspec

@@ -34,4 +34,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "pry"
+  spec.add_development_dependency "yard"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rlyft
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Taylor Scott
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  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: Ruby wrapper for Lyft API.
 email:
 - t.skukx@gmail.com