citybikes_api 0.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f91ce098bd210ba468ad187303179fbeb1678383
-  data.tar.gz: fb8b84adbd697181b9e03ce6382afbd1c688f596
+  metadata.gz: 023d6a354f3510731f6961806f642958fc59f1f3
+  data.tar.gz: 6baef3ed49ad9f16f5aa259f94523e96665ee9e5
 SHA512:
-  metadata.gz: 9a029d6d1f4af8082805bf7b8e0bc6e97ad875a8e159b1b02122af5e0ce46c438afe3a1c575fdd7cabf99c1f7660eedd6a575af8c69661c1d68de6ce02c97be7
-  data.tar.gz: 5c6e4858140f737ad9f9b02fbeb89b5fbdcfa48cc8bd256a8a9c3eca541abf7d1c92b4495785d7c7e3bb22fc3736298cd58e3581ea14473adac506ddde26a6fa
+  metadata.gz: 8e6236c38e3405de262769be0767eb49fa240133a38d2f3a5e746026fc552e308e48c87ec4fd08c28df3006f79dccf7ca605e03e3d9b94d63a5a5d6e9ee1197b
+  data.tar.gz: 3670331f6e7c82ff4fe3b4986450069d97b9fbacdb41f125d23806a48e42cf6864615015c0f32139288d51cfd92a8295f92878e1ca5816ca77bb9472e91b80ab

data/README.md

@@ -1,6 +1,9 @@
 # CitybikesApi - Ruby
 
-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).
+ Includes endpoints for bike-share network and station data.
+
+[![Gem Version](https://badge.fury.io/rb/citybikes_api.svg)](https://badge.fury.io/rb/citybikes_api)
 
 ## Installation
 

data/lib/citybikes_api.rb

@@ -1,7 +1,9 @@
 require "citybikes_api/version"
 require "httparty"
 
+# A collection of methods to facilitate citybikes api requests.
 module CitybikesApi
+  # The base url for all endpoint requests.
   BASE_URL = "http://api.citybik.es/v2"
 
   # Networks Endpoint
@@ -12,6 +14,12 @@ module CitybikesApi
     response = HTTParty.get("#{BASE_URL}/networks")
   end
 
+  # Network Endpoint
+  #
+  # @param [String] network_id The unique bike-share network identifier assigned by citybikes.
+  #
+  # @example CityBikesApi.network("capital-bikeshare")
+  #
   def self.network(network_id)
     response = HTTParty.get("#{BASE_URL}/networks/#{network_id}")
   end

data/lib/citybikes_api/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: citybikes_api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - MJ Rossetti (@s2t2)