safer_bus_api 0.0.1 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a1deaf4c103576f67cc498b9c7a786b4ac93a765
-  data.tar.gz: bfb84476d5245c2da30f3faef1fae0c3973d92ae
+  metadata.gz: 67ce3c5993fb98a883ab27f78d29290f899ce970
+  data.tar.gz: 422c1a4920d21ab40c4c461df80685d2309a8a0b
 SHA512:
-  metadata.gz: 6119b904f8d31b489970d942da3a8e44ddf93b5b3b2cd2dbda19a84711b4348d624ae5860704b001d5e153e4b6353fa8bbdeff628081432579e5ff13c1ae35e7
-  data.tar.gz: eda7bc88a59b871d46e9987f83f71228d5d32748143aca7b248ee3a2e06f7783a9fc4adf51d9fee7626704fd7feab24c0b6fd59941362af75d24127a2f1f896e
+  metadata.gz: 75092fc44c8a481edd2a95756c2c12336d38eff7a1c67ac4b9cb184a85c3c21973286c8cf782d1b471a83ea1b59e7c42bd0aae0eaffda27e874634f8448478e9
+  data.tar.gz: b65faaa39261c9950796bf8c15e4a06bb2090f60b8e92fb4cfd7936bbb7c179534615fb4c17045307b7208a15a5c49bf158722782c707ed9ad83d271c6c321f1

data/README.md

@@ -28,9 +28,32 @@ SaferBusApi.configure do |config|
 end
 ```
 
-## Usage
+## Example Usage
 
+### Query by DOT number:
 
+```ruby
+  request = SaferBusApi::Request.new(dot_number: '44110')
+  response = request.perform
+  response.data # Returns a formatted hash
+  response.raw_data # Returns the raw response from 
+```
+
+### Query by Company Name:
+
+```ruby
+  request = SaferBusApi::Request.new(company_name: 'greyhound') # Note: company name should have no spaces and be all lower case.
+  response = request.perform
+  response.data # Returns a formatted hash
+```
+
+### Query by MC Number:
+
+```ruby
+  request = SaferBusApi::Request.new(mc_number: '1515') # Note: company name should have no spaces and be all lower case.
+  response = request.perform
+  response.data # Returns a formatted hash
+```
 
 ## Author
 [Nathan Bertram](https://github.com/nathanbertram)

data/lib/safer_base_api.rb

@@ -1,43 +1,15 @@
-require "safer_bus_api/version"
-require 'duly_noted/configuration'
+require 'typhoeus'
+require 'safer_bus_api/version'
+require 'safer_bus_api/configuration'
+require 'safer_bus_api/query'
+require 'safer_bus_api/request'
+require 'safer_bus_api/response'
 
 module SaferBusApi
-  BASE_URL = 'https://mobile.fmcsa.dot.gov/saferbus/resource/v1/'
+  module_function
 
   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/query.rb

@@ -0,0 +1,23 @@
+module SaferBusApi
+  class Query
+    BASE_URL = 'https://mobile.fmcsa.dot.gov/saferbus/resource/v1/'
+    
+    def self.by_company_name(company_name)
+      fetch_data("carriers/#{company_name}")
+    end
+
+    def self.by_dot_number(dot_number)
+      fetch_data("carrier/#{dot_number}")
+    end
+
+    def self.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 response.body
+    end
+  end
+end

data/lib/safer_bus_api/request.rb

@@ -0,0 +1,29 @@
+module SaferBusApi
+  class Request
+    def initialize(opts={})
+      @dot_number = opts[:dot_number]
+      @company_name = opts[:company_name]
+      @mc_number = opts[:mc_number]
+
+      @response = nil
+    end
+
+    def perform
+      if @dot_number.present?
+        @response = SaferBusApi::Query.by_dot_number(@dot_number)
+      elsif @company_name.present?
+        @response = SaferBusApi::Query.by_company_name(@company_name)
+      elsif @mc_number.present?
+        @response = SaferBusApi::Query.by_mc_number(@mc_number)
+      else
+        raise 'SaferBusApi Error: Need to set either a dot_number, company_name or mc_number.' 
+      end
+
+      Response.new(@response)
+    end
+
+    def response
+      @response
+    end
+  end
+end

data/lib/safer_bus_api/response.rb

@@ -0,0 +1,15 @@
+module SaferBusApi
+  class Response
+    def initialize(raw_data)
+      @raw_data = raw_data
+    end
+
+    def data
+      JSON.parse(@raw_data)
+    end
+
+    def raw_data
+      @raw_data
+    end
+  end
+end

data/lib/safer_bus_api/version.rb

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

data/safer_bus_api.gemspec

@@ -17,6 +17,6 @@ Gem::Specification.new do |gem|
   gem.license       = 'MIT'
 
   gem.add_development_dependency('rspec')
-  gem.add_dependency('typhoeus')
+  gem.add_dependency 'typhoeus', '~> 0.6'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: safer_bus_api
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.4
 platform: ruby
 authors:
 - Nathan Bertram
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-14 00:00:00.000000000 Z
+date: 2014-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -28,16 +28,16 @@ dependencies:
   name: typhoeus
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.6'
 description: The Department of Transportation maintains the SaferBusAPI to provide
   safety information pertaining to transporation companies.
 email:
@@ -50,6 +50,9 @@ files:
 - README.md
 - lib/safer_base_api.rb
 - lib/safer_bus_api/configuration.rb
+- lib/safer_bus_api/query.rb
+- lib/safer_bus_api/request.rb
+- lib/safer_bus_api/response.rb
 - lib/safer_bus_api/version.rb
 - safer_bus_api.gemspec
 homepage: http://github.com/TanookiSuitLabs/safer_bus_api
@@ -72,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: A simple wrapper for the SaferBusAPI