actransit_rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ad1f9e6df558a900e021aa1baf9ebc46922be315
+  data.tar.gz: 6321e8df8df27364c171dfe85c738d0ee162f735
+SHA512:
+  metadata.gz: cb3af51e723d196d3891751d0ce2e1e736d1638d618ceae353766353f530c0301acf4e7a1413148a3718ccb996bbaaa7db41d19a4290a10aaa93173e313f4399
+  data.tar.gz: 3f8f4731a44ca1b996556802d10e498eea3313fbd77012a99d8f40e0d7e6631695bcefbb4e3dc824599eb033a9555c676c6691cdde617b9310b10a73a8cc05f1

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/spec/support/secrets.rb

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.1
+before_install: gem install bundler -v 1.10.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in actransit_rails.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Sanjay Y Patel
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,77 @@
+# ActransitRails
+
+A gem for accessing the ACTransit API in Rails.  
+
+Checkout the ACTransit [Documentation](http://api.actransit.org/transit/) for more info.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'actransit_rails'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install actransit_rails
+
+## Usage
+
+1. Make sure you [register an application](http://api.actransit.org/transit/Account/Register) with ACTransit to get your access token.
+
+2. I'd recommend using a gem like [figaro](https://github.com/laserlemon/figaro) to safely store your ACTransit access token as an environment variable.
+
+3. In controller that will make requests to the ACTransit api, be sure to call configure with your token as an argument.
+
+```ruby
+# If you're using figaro, it would look like
+ACTransitRails.configure(ENV['ACTRANSIT_TOKEN'])
+
+# You coud also just pass it as a string, though I don't recommend that
+ACTransitRails.configure("myactransittoken")
+```
+
+4. Once configured, you can use the helper methods to make requests from the api.  Responses will be formatted as either a hash or an array of hashes depending on what you request.
+
+```ruby
+# returns array of hashes
+ACTransitRails.get_all_routes
+# => [{"RouteId":"1","Name":"1","Description":"Bayfair Bart- Dtn. Berkeley"},...]
+
+
+# returns hash
+ACTransitRails.get_route('E')
+# => {"RouteId":"E","Name":"E","Description":"San Francisco - Claremont -Parkwood"}
+
+# returns array of hashes
+ACTransitRails.get_trips('E')
+# => [{"TripId":4119214,"RouteName":"E","ScheduleType":0,"StartTime":"2000-01-01T06:05:00","Direction":"Eastbound"},...]
+
+# returns array of strings
+ACTransitRails.get_directions('E')
+# => ["Eastbound","Westbound"]
+
+# returns array of hashes
+ACTransitRails.get_stops('E')
+ACTransitRails.get_stops('E', 4119214)
+# => [{"StopId":58070,"Name":"Claremont Av:Hudson St","Latitude":37.8431470,"Longitude":-122.2571661,"ScheduledTime":null},...]
+
+```
+
+
+## Contributing
+
+Make sure to setup a spec/support/secrets.rb file (see secrets_example.rb) with your token so that you can securely test.
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/actransit_rails. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+Dir.glob('tasks/**/*.rake').each(&method(:import))

data/actransit_rails.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'actransit_rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "actransit_rails"
+  spec.version       = ACTransitRails::VERSION
+  spec.authors       = ["Sanjay Y Patel"]
+  spec.email         = ["sanjay.y.patel@gmail.com"]
+
+  spec.summary       = %q{A gem for accessing the ACTransit API in Rails.}
+  spec.description   = %q{Simplified access to the Bay Area's ACTransit API - details at http://api.actransit.org/transit/}
+  spec.homepage      = "https://github.com/sanjayypatel/actransit_rails.git"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'json'
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'rspec'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "actransit_rails"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/actransit_rails.rb

@@ -0,0 +1,87 @@
+require "actransit_rails/version"
+require 'json'
+
+module ACTransitRails
+
+  attr_writer :actransit_token
+
+  def self.configure(actransit_token)
+    @actransit_token = actransit_token
+  end
+
+  def self.get_all_routes
+    uri = URI.parse(
+      base_url + 
+      "routes/" + 
+      search_string + 
+      my_token
+    )
+    return get_response(uri)
+  end
+
+  def self.get_route(route_name)
+    uri = URI.parse(
+      base_url + 
+      "route/" + 
+      "#{route_name}/" + 
+      search_string + 
+      my_token
+    )
+    return get_response(uri)
+  end
+
+  def self.get_trips(route_name)
+    uri = URI.parse(
+      base_url + 
+      "route/" + 
+      "#{route_name}/trips/" + 
+      search_string + 
+      my_token
+    )
+    return get_response(uri)
+  end
+
+  def self.get_directions(route_name)
+    uri = URI.parse(
+      base_url + 
+      "route/" + 
+      "#{route_name}/directions/" + 
+      search_string + 
+      my_token
+    )
+    return get_response(uri)
+  end
+
+  def self.get_stops(route_name, trip = nil)
+    trip ||= get_trips(route_name)[0]["TripId"]
+    uri = URI.parse(
+      base_url + 
+      "route/" + 
+      "#{route_name}/trip/" + 
+      "#{trip}/stops/" + 
+      search_string + 
+      my_token
+    )
+    return get_response(uri)
+  end
+
+  private
+
+  def self.base_url
+    return "http://api.actransit.org/transit/"
+  end
+
+  def self.search_string
+    "?"
+  end
+
+  def self.my_token
+    return "token=" + @actransit_token
+  end
+
+  def self.get_response(uri)
+    http = Net::HTTP.new(uri.host, uri.port)
+    response = http.request(Net::HTTP::Get.new(uri.request_uri))
+    return JSON.parse response.body
+  end
+end

data/lib/actransit_rails/version.rb

@@ -0,0 +1,3 @@
+module ACTransitRails
+  VERSION = "0.1.0"
+end

data/tasks/rspec.rake

@@ -0,0 +1,3 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: actransit_rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sanjay Y Patel
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-07-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: Simplified access to the Bay Area's ACTransit API - details at http://api.actransit.org/transit/
+email:
+- sanjay.y.patel@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".DS_Store"
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- actransit_rails.gemspec
+- bin/console
+- bin/setup
+- lib/actransit_rails.rb
+- lib/actransit_rails/version.rb
+- tasks/rspec.rake
+homepage: https://github.com/sanjayypatel/actransit_rails.git
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: A gem for accessing the ACTransit API in Rails.
+test_files: []