parkwhiz 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: daf3fa24873048348de4cec14e569370581adaab
+  data.tar.gz: edc81c594b145791c5bef3c3ccc0bc23d792f901
+SHA512:
+  metadata.gz: b6bf8d75505ee5774fe0ee0ce302cd7b3f38dea73f007332a0373323eb8c71abbd059c8a324ba2fd9fc31f8849d3c5a023cee343677a75f61d7ffce648a29959
+  data.tar.gz: d50f7b902666ee84b364230dd29322e37ed7332b88154df8a5f77983d45d720dd08a1804532fe0351be86b4f8b6c565627e282dd0949fd332173786cd5ee9b03

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,4 @@
+--color
+--format progress
+--require spec_helper
+--pattern "spec/**/*_spec.rb"

data/CHANGELOG.rdoc

@@ -0,0 +1,2 @@
+=== 0.1.0
+  - Search API endpoint

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Austin Fonacier
+
+MIT License
+
+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,41 @@
+# Parkwhiz
+
+A gem wrapper to Parkwhiz API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'parkwhiz'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install parkwhiz
+
+## Usage
+
+```ruby
+
+# Set your api key
+Parkwhiz.api_key = "my api key"
+
+locations = Parkwhiz.search({destination: '1 World Way, Los Angeles, CA 90045'})
+# Array of ParkwhizLocations
+```
+## Run Specs
+
+```
+rake
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/parkwhiz/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')
+task :default => :spec
+task :test => :spec

data/lib/parkwhiz.rb

@@ -0,0 +1,13 @@
+require 'parkwhiz/version'
+require 'faraday'
+require 'faraday_middleware'
+require 'virtus'
+require 'parkwhiz/errors'
+require 'parkwhiz/configuration'
+require 'parkwhiz/connection'
+require 'parkwhiz/location'
+require 'parkwhiz/search'
+
+module Parkwhiz
+
+end

data/lib/parkwhiz/configuration.rb

@@ -0,0 +1,13 @@
+module Parkwhiz
+  def self.configure
+    yield self
+  end
+
+  def self.api_key=(api_key)
+    @@api_key = api_key
+  end
+
+  def self.api_key
+    @@api_key
+  end
+end

data/lib/parkwhiz/connection.rb

@@ -0,0 +1,14 @@
+module Parkwhiz
+  def self.connection=(connection)
+    @connection = connection
+  end
+
+  def self.connection
+    @connection ||= Faraday.new(url: 'http://api.parkwhiz.com') do |faraday|
+      faraday.request  :url_encoded             # form-encode POST params
+      faraday.response :logger                  # log requests to STDOUT
+      faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
+      faraday.response :json
+    end
+  end
+end

data/lib/parkwhiz/errors.rb

@@ -0,0 +1,4 @@
+module Parkwhiz
+  class SearchError < StandardError
+  end
+end

data/lib/parkwhiz/location.rb

@@ -0,0 +1,33 @@
+module Parkwhiz
+  class Location
+    include Virtus.model
+    attribute :name, String
+    attribute :location_name, String
+    attribute :location_id, Integer
+    attribute :listing_id, Integer
+    attribute :parkwhiz_url, String
+    attribute :api_url, String
+    attribute :address, String
+    attribute :city, String
+    attribute :state, String
+    attribute :zip, String
+    attribute :lat, Float
+    attribute :lng, Float
+    attribute :distance, Integer
+    attribute :recommendations, Integer
+    attribute :reservation, Integer
+    attribute :eticket, Boolean
+    attribute :valet, Boolean
+    attribute :indoor, Boolean
+    attribute :shuttle, Boolean
+    attribute :tailgate, Boolean
+    attribute :security, Boolean
+    attribute :restroom, Boolean
+    attribute :attended, Boolean
+    attribute :rv, Boolean
+    attribute :available_spots, Integer
+    attribute :price, Float
+    attribute :www_reserve_url, String
+    attribute :api_reserve_url, String
+  end
+end

data/lib/parkwhiz/search.rb

@@ -0,0 +1,23 @@
+module Parkwhiz
+
+  SEARCH_PATH = "/search/"
+
+  # Search
+  #
+  # Returns:
+  # Array of ParkWhiz::Location
+  #
+  # Endpoint: http://www.parkwhiz.com/developers/search/
+  #
+  def self.search(search_parameters)
+    response = connection.get do |request|
+      request.url SEARCH_PATH
+      request.params['key'] = api_key
+      request.params.merge!(search_parameters)
+    end
+
+    raise SearchError.new(response.body['error']) if response.body['error']
+
+    response.body['parking_listings'].collect{|parking_listing_json| Location.new(parking_listing_json)}
+  end
+end

data/lib/parkwhiz/version.rb

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

data/parkwhiz.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'parkwhiz/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "parkwhiz"
+  spec.version       = Parkwhiz::VERSION
+  spec.authors       = ["Austin Fonacier"]
+  spec.email         = ["austinrf@gmail.com"]
+  spec.summary       = "A Ruby gem wrapper to Parkwhiz.com's API"
+  spec.description   = "A Ruby gem wrapper to Parkshiz.com's API.  Information on the API can be found here: http://www.parkwhiz.com/developers/"
+  spec.homepage      = "http://github.com/austinrfnd/parkwhiz"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'rspec', '~> 3.0.0'
+  spec.add_development_dependency 'json', '~> 1.8.1'
+  spec.add_dependency 'faraday'
+  spec.add_dependency 'virtus'
+  spec.add_dependency 'faraday_middleware'
+end

data/spec/location_spec.rb

@@ -0,0 +1,5 @@
+describe "Location" do
+  it "should be kind of Parkwhiz::Location" do
+    expect(Parkwhiz::Location.new).to be_kind_of(Parkwhiz::Location)
+  end
+end

data/spec/responses/invalid_key_response.json

@@ -0,0 +1 @@
+{"error":"Key required. See documentation at http:\/\/www.parkwhiz.com\/developers\/"}

data/spec/responses/la_search_response.json

@@ -0,0 +1 @@
+{"parkwhiz_url":"http:\/\/www.parkwhiz.com\/search\/?destination=Current+Location&start=1406161800&end=1406172600&pwa=ee51","lat":33.942809,"lng":-118.404706,"locations":2,"min_price":12,"max_price":13,"min_distance":4000,"max_distance":4750,"amenities":{"shuttle":2,"eticket":2,"perk":0,"valet":1,"indoor":0,"handicap":0,"restroom":0,"security":0,"tailgate":0,"rv":0,"unobstructed":1,"attended":2},"parking_listings":[{"location_name":"Sunrise Parking - LAX","location_id":4952,"listing_id":160981,"parkwhiz_url":"https:\/\/www.parkwhiz.com\/p\/los-angeles-parking\/6155-w-98th-st\/?start=1406161800&end=1406172600&pwa=ee51","api_url":"https:\/\/api.parkwhiz.com\/p\/los-angeles-parking\/6155-w-98th-st\/?start=1406161800&end=1406172600","address":"6155 W. 98th St.","city":"Los Angeles","state":"CA","zip":"90045","lat":33.947508845936,"lng":-118.39278131283,"distance":4000,"recommendations":0,"reservation":1,"eticket":1,"valet":0,"indoor":0,"shuttle":1,"tailgate":0,"security":0,"restroom":0,"attended":1,"rv":0,"available_spots":10,"price":12,"www_reserve_url":"https:\/\/www.parkwhiz.com\/reserve\/?id=160981&start=1406161800&end=1406172600&pwa=ee51","api_reserve_url":"https:\/\/api.parkwhiz.com\/reserve\/?id=160981&start=1406161800&end=1406172600&pwa=ee51"},{"location_name":"Crowne Plaza LAX","location_id":2409,"listing_id":4704,"parkwhiz_url":"https:\/\/www.parkwhiz.com\/p\/los-angeles-parking\/5985-w-century-blvd\/?start=1406161800&end=1406172600&pwa=ee51","api_url":"https:\/\/api.parkwhiz.com\/p\/los-angeles-parking\/5985-w-century-blvd\/?start=1406161800&end=1406172600","address":"5985 W. Century Blvd.","city":"Los Angeles","state":"CA","zip":"90045","lat":33.94644429732,"lng":-118.38965411178,"distance":4750,"recommendations":213,"reservation":1,"eticket":1,"valet":1,"indoor":0,"shuttle":1,"tailgate":0,"security":0,"restroom":0,"attended":1,"rv":0,"available_spots":10,"price":13,"www_reserve_url":"https:\/\/www.parkwhiz.com\/reserve\/?id=4704&start=1406161800&end=1406172600&pwa=ee51","api_reserve_url":"https:\/\/api.parkwhiz.com\/reserve\/?id=4704&start=1406161800&end=1406172600&pwa=ee51"}]}

data/spec/search_spec.rb

@@ -0,0 +1,37 @@
+describe "Search" do
+  let :connection do
+    double(:connection, get: nil)
+  end
+
+  let :la_search_response do
+    File.read(File.expand_path("spec/responses/la_search_response.json"))
+  end
+
+  let :invalid_search_response do
+    File.read(File.expand_path("spec/responses/invalid_key_response.json"))
+  end
+
+  before :each do
+    Parkwhiz.api_key = 'asdf1234'
+  end
+
+  context "on successful search" do
+    it "should return an array of Parkwhiz::Locations" do
+      expect(connection).to receive(:get) { double( body: JSON.parse(la_search_response) ) }
+      Parkwhiz.connection = connection
+      locations = Parkwhiz.search({})
+      expect(locations).to be_kind_of(Array)
+      expect(locations.first).to be_kind_of(Parkwhiz::Location)
+    end
+  end
+
+  context 'on error' do
+    it "should raise a Parkwhiz::SearchError" do
+      expect(connection).to receive(:get) { double( body: JSON.parse(invalid_search_response) ) }
+      Parkwhiz.connection = connection
+      expect do
+        Parkwhiz.search({})
+      end.to raise_error(Parkwhiz::SearchError)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'parkwhiz'
+require 'json'

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification
+name: parkwhiz
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Austin Fonacier
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+- !ruby/object:Gem::Dependency
+  name: faraday
+  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: virtus
+  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: faraday_middleware
+  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: 'A Ruby gem wrapper to Parkshiz.com''s API.  Information on the API can
+  be found here: http://www.parkwhiz.com/developers/'
+email:
+- austinrf@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.rdoc
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/parkwhiz.rb
+- lib/parkwhiz/configuration.rb
+- lib/parkwhiz/connection.rb
+- lib/parkwhiz/errors.rb
+- lib/parkwhiz/location.rb
+- lib/parkwhiz/search.rb
+- lib/parkwhiz/version.rb
+- parkwhiz.gemspec
+- spec/location_spec.rb
+- spec/responses/invalid_key_response.json
+- spec/responses/la_search_response.json
+- spec/search_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/austinrfnd/parkwhiz
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A Ruby gem wrapper to Parkwhiz.com's API
+test_files:
+- spec/location_spec.rb
+- spec/responses/invalid_key_response.json
+- spec/responses/la_search_response.json
+- spec/search_spec.rb
+- spec/spec_helper.rb