safer_bus_api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a1deaf4c103576f67cc498b9c7a786b4ac93a765
+  data.tar.gz: bfb84476d5245c2da30f3faef1fae0c3973d92ae
+SHA512:
+  metadata.gz: 6119b904f8d31b489970d942da3a8e44ddf93b5b3b2cd2dbda19a84711b4348d624ae5860704b001d5e153e4b6353fa8bbdeff628081432579e5ff13c1ae35e7
+  data.tar.gz: eda7bc88a59b871d46e9987f83f71228d5d32748143aca7b248ee3a2e06f7783a9fc4adf51d9fee7626704fd7feab24c0b6fd59941362af75d24127a2f1f896e

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 Bustr, Inc.
+
+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,46 @@
+# Overview
+
+The Department of Transportation maintains the SaferBusAPI to provide safety information pertaining to transporation companies.  Information related to this API and instructions for access the API can be found here: [https://mobile.fmcsa.dot.gov/developer/apidescription.page?cid=561](https://mobile.fmcsa.dot.gov/developer/apidescription.page?cid=561)
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+```ruby
+gem 'safer_bus_api'
+```
+
+Then run:
+```
+bundle install
+```
+
+### Configuration
+
+Set your api_token obtained from registering at [https://mobile.fmcsa.dot.gov/developer/UserAccountCreate.page](https://mobile.fmcsa.dot.gov/developer/UserAccountCreate.page)
+
+Note: Once registered you will be emailed a registration token which you can then use to complete your registration and obtain an api token for your application
+
+
+```ruby
+SaferBusApi.configure do |config|
+  config.api_token = 'your-token-here'
+end
+```
+
+## Usage
+
+
+
+## Author
+[Nathan Bertram](https://github.com/nathanbertram)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Ensure tests are passing with `rspec`
+4. Commit your changes (`git commit -am 'Added some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request
+7. You da man!

data/lib/safer_base_api.rb

@@ -0,0 +1,43 @@
+require "safer_bus_api/version"
+require 'duly_noted/configuration'
+
+module SaferBusApi
+  BASE_URL = 'https://mobile.fmcsa.dot.gov/saferbus/resource/v1/'
+
+  def configure
+    yield SaferBusApi::Configuration
+  end
+
+  def initialize(opts={})
+    @dot_number = opts[:dot_number]
+    @response = nil
+  end
+
+  def perform
+    raise 'Cannot perform SaferBusApi api-request with empty dot_number' if @dot_number.blank?
+    @response = SaferBusApi.query_by_dot_number(@dot_number)
+  end
+
+  def response
+    @response
+  end
+
+  def self.query_by_company_name(company_name)
+    fetch_data("carriers/#{company_name}")
+  end
+
+  def self.query_by_dot_number(dot_number)
+    fetch_data("carrier/#{dot_number}")
+  end
+
+  def self.query_by_mc_number(mc_number)
+    fetch_data("carrier/#{mc_number}")
+  end
+
+  def self.fetch_data(url_suffix)
+    url = "#{BASE_URL}#{url_suffix}.json?start=1&size=10&webKey=#{SaferBusApi::Configuration.api_token}"
+    response = Typhoeus.get(url)
+    return JSON.parse(response.body)
+  end
+
+end

data/lib/safer_bus_api/configuration.rb

@@ -0,0 +1,32 @@
+module SaferBusApi
+  module Configuration
+    module_function
+    @data = {:api_token => ''}
+
+    def update!(data)
+      data.each do |key, value|
+        self[key] = value
+      end
+    end
+
+    def [](key)
+      @data[key.to_sym]
+    end
+
+    def []=(key, value)
+      if value.class == Hash
+        @data[key.to_sym] = Config.new(value)
+      else
+        @data[key.to_sym] = value
+      end
+    end
+
+    def method_missing(sym, *args)
+      if sym.to_s =~ /(.+)=$/
+        self[$1] = args.first
+      else
+        self[sym]
+      end
+    end
+  end
+end

data/lib/safer_bus_api/version.rb

@@ -0,0 +1,3 @@
+class SaferBusApi
+  VERSION = "0.0.1"
+end

data/safer_bus_api.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/safer_bus_api/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Nathan Bertram"]
+  gem.email         = ["nbertram@gmail.com"]
+  gem.description   = %q{The Department of Transportation maintains the SaferBusAPI to provide safety information pertaining to transporation companies.}
+  gem.summary       = %q{A simple wrapper for the SaferBusAPI}
+  gem.homepage      = "http://github.com/TanookiSuitLabs/safer_bus_api"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "safer_bus_api"
+  gem.require_paths = ["lib"]
+  gem.version       = SaferBusApi::VERSION
+  gem.license       = 'MIT'
+
+  gem.add_development_dependency('rspec')
+  gem.add_dependency('typhoeus')
+
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: safer_bus_api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nathan Bertram
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-14 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  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'
+description: The Department of Transportation maintains the SaferBusAPI to provide
+  safety information pertaining to transporation companies.
+email:
+- nbertram@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- lib/safer_base_api.rb
+- lib/safer_bus_api/configuration.rb
+- lib/safer_bus_api/version.rb
+- safer_bus_api.gemspec
+homepage: http://github.com/TanookiSuitLabs/safer_bus_api
+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.1.11
+signing_key: 
+specification_version: 4
+summary: A simple wrapper for the SaferBusAPI
+test_files: []