Citibike - Wrapper for the unofficial Citibike NYC API

  # Here's an example for stations, it also provides data about
  # branches and helmets with more or less equivalent methods
  helmets = Citibike.helmets
  branches = Citibike.branches

  # Returns a Citibike::Responses::Station object
  stations = Citibike.stations

  # This object contains the attributes of the response
  stations.success?     # True if the response was successful
  stations.last_update  # The time this data was last updated

  # The response object includes Enumerable and proxies
  # unknown methods to an underlying array
  stations.each do |s|
    puts s.class              # Citibike::Station
    puts s.latitude           # Float
    puts s.longitude          # Float
    puts s.available_bikes    # Integer
    puts s.available_docks    # Integer
    puts s.id                 # Integer id
  end

  # It's also simple to find stations within a given distance
  # (in miles) of a LAT/LONG pair (in degrees)
  # nearby will be an array of Citibike::Station objects
  nearby = stations.all_within(LAT, LONG, DISTANCE)

  # You can do the same thing given an instance of Citibike::Station
  # Note that the results do NOT include station itself
  nearby = stations.all_near(station, DISTANCE)

  # It's also convenient to look up results by id within the
  # list of stations
  station = stations.find_by_id(ID)

  # It also supports a variadic version
  stats = stations.find_by_ids(ID1, ID2,...)

  # Sometimes it might be convenient to a list of stations
  # but still retain the methods of the Citibike::Responses::Station
  # object.
  filtered_stations = stations.clone_with(stations.select(&:active?))

  client = Citibike::Client.new   # initializes a default client

  client.stations                 # returns Citibike::Responses::Station
  client.helmets                  # returns Citibike::Responses::Helmet
  client.branches                 # returns Citibike::Responses::Branch

  # The simplest option is to unwrap the responses in which case they
  # come back as a simple hash not a custom object
  client = Citibike::Client.new(unwrapped: true)
  client.stations                 # Instance of Hash

  # Other configuration options and their default values
  {
    adapter: Faraday.default_adapter,
    headers: {
      'Accept' => 'application/json; charset=utf-8',
      'UserAgent' => 'Citibike Gem'
    },
    proxy: nil,
    ssl: {
      verify: false
    },
    debug: false,          # Turns on connection logging(currently unused)
    test: false,           # True if in a test
    stubs: nil,            # Stubs for the test connection
    raw: false,            # Don't process the response in any way
    format_path: true,     # Append the format to the request path  if it lacks one
    format: :json,         # Default format
    url: 'http://appservices.citibikenyc.com/'
  }