citybikes_api 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 023d6a354f3510731f6961806f642958fc59f1f3
-  data.tar.gz: 6baef3ed49ad9f16f5aa259f94523e96665ee9e5
+  metadata.gz: 88d592037677bcce62bf6d8ea72179f13542958f
+  data.tar.gz: 2fd4f6eca577525be49fccc20d88d3f835465c93
 SHA512:
-  metadata.gz: 8e6236c38e3405de262769be0767eb49fa240133a38d2f3a5e746026fc552e308e48c87ec4fd08c28df3006f79dccf7ca605e03e3d9b94d63a5a5d6e9ee1197b
-  data.tar.gz: 3670331f6e7c82ff4fe3b4986450069d97b9fbacdb41f125d23806a48e42cf6864615015c0f32139288d51cfd92a8295f92878e1ca5816ca77bb9472e91b80ab
+  metadata.gz: 6ce0f7e19774e6a2e0e6836f082f806223938bf33f09cd4b9365abdc87ba1264b639a409d09fbb120a48aae3257da15a247a12ac8254819519d67a3add9de987
+  data.tar.gz: 91e697245f6b6ea3d759ddc4c930bf94f6b8c4bfc2c51b3d89c0ad16e17988d7f4480bc9ee77cab321c7062c553feae240bf3b1012e6026321f1804ae15a26b0

data/README.md

@@ -1,7 +1,8 @@
-# CitybikesApi - Ruby
+# CityBikes API - Ruby :bike: :bike: :bike:
 
-A ruby interface to the [CityBikes API](http://api.citybik.es/v2/) (v2).
- Includes endpoints for bike-share network and station data.
+A ruby interface to the [CityBikes API](http://api.citybik.es/v2/) v2.
+ Returns data about bike-share networks and stations.
+ Includes options to customize API requests.
 
 [![Gem Version](https://badge.fury.io/rb/citybikes_api.svg)](https://badge.fury.io/rb/citybikes_api)
 
@@ -15,21 +16,46 @@ gem install citybikes_api
 
 ## Usage
 
-Get a list of all bike-share networks.
+### Requests
+
+#### Networks Endpoint
+
+List all bike-share networks.
 
 ```` rb
 response = CitybikesApi.networks
-puts response["networks"]
+puts response["networks"] #=> returns an Array of Hash objects
 ````
 
-Find a given bike-share network and all of its stations.
+#### Network Endpoint
+
+Find a bike-share network by its CityBikes identifier.
 
 ```` rb
+network_id = "capital-bikeshare"
 response = CitybikesApi.network(network_id)
-puts response["network"]
-puts response["network"]["stations"]
+puts response["network"] #=> returns a Hash object
+````
+
+### Request Options
+
+Customize any network request by passing URL parameters.
+
+```` rb
+request_options = {:fields => "id,name,href"}
+response = CitybikesApi.networks(request_options)
+puts response["networks"] #=> returns an Array of Hash objects, each of which should only contain the requested fields/attributes
+````
+
+```` rb
+network_id = "capital-bikeshare"
+request_options = {:fields => "id,name,href"}
+response = CitybikesApi.network(network_id, request_options)
+puts response["network"] #=> returns a Hash object which should only contain the requested fields/attributes
 ````
 
+See [CityBikes documentation](http://api.citybik.es/v2/#Syntax) for more info about field-filtering.
+
 ## Contributing
 
 Browse existing [issues](https://github.com/data-creative/citybikes-api-ruby/issues) or create a new issue to communicate bugs, desired features, etc.

data/citybikes_api.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["MJ Rossetti (@s2t2)"]
   spec.email         = ["s2t2mail+git@gmail.com"]
 
-  spec.summary       = %q{A ruby interface to the CityBikes API (v2). Includes endpoints for bike-share network and station data.}
-  spec.description   = %q{A ruby interface to the CityBikes API (v2). Includes endpoints for bike-share network and station data.}
+  spec.summary       = %q{A ruby interface to the CityBikes API v2. Returns data about bike-share networks and stations. Includes options to customize API requests.}
+  spec.description   = %q{A ruby interface to the CityBikes API v2. Returns data about bike-share networks and stations. Includes options to customize API requests.}
   spec.homepage      = "https://github.com/data-creative/citybikes-api-ruby"
   spec.license       = "MIT"
 

data/lib/citybikes_api.rb

@@ -8,19 +8,26 @@ module CitybikesApi
 
   # Networks Endpoint
   #
+  # @param [Hash] options An object of named URL parameters to pass along with the request.
+  # @param [Hash] options [String] :field A comma-separated string of network object attributes.
+  #
   # @example CityBikesApi.networks
+  # @example CityBikesApi.networks({:fields => "id,name,href"})
   #
-  def self.networks
-    response = HTTParty.get("#{BASE_URL}/networks")
+  def self.networks(options = {})
+    HTTParty.get("#{BASE_URL}/networks", :query => options)
   end
 
   # Network Endpoint
   #
   # @param [String] network_id The unique bike-share network identifier assigned by citybikes.
+  # @param [Hash] options An object of named URL parameters to pass along with the request.
+  # @param [Hash] options [String] :field A comma-separated string of network object attributes.
   #
   # @example CityBikesApi.network("capital-bikeshare")
+  # @example CityBikesApi.network("capital-bikeshare", {:fields => "id,name,href"})
   #
-  def self.network(network_id)
-    response = HTTParty.get("#{BASE_URL}/networks/#{network_id}")
+  def self.network(network_id, options = {})
+    HTTParty.get("#{BASE_URL}/networks/#{network_id}", :query => options)
   end
 end

data/lib/citybikes_api/version.rb

@@ -1,4 +1,4 @@
 module CitybikesApi
   # The major version of this gem should correspond to the citybikes api version.
-  VERSION = "2.0.0"
+  VERSION = "2.0.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: citybikes_api
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - MJ Rossetti (@s2t2)
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-26 00:00:00.000000000 Z
+date: 2015-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -122,8 +122,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.13'
-description: A ruby interface to the CityBikes API (v2). Includes endpoints for bike-share
-  network and station data.
+description: A ruby interface to the CityBikes API v2. Returns data about bike-share
+  networks and stations. Includes options to customize API requests.
 email:
 - s2t2mail+git@gmail.com
 executables: []
@@ -168,7 +168,7 @@ rubyforge_project:
 rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
-summary: A ruby interface to the CityBikes API (v2). Includes endpoints for bike-share
-  network and station data.
+summary: A ruby interface to the CityBikes API v2. Returns data about bike-share networks
+  and stations. Includes options to customize API requests.
 test_files: []
 has_rdoc: