campgrounds 0.0.1

data/.rvmrc

@@ -0,0 +1,48 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
+# Only full ruby name is supported here, for short names use:
+#     echo "rvm use 1.9.3" > .rvmrc
+environment_id="ruby-1.9.3-p194@campgrounds"
+
+# Uncomment the following lines if you want to verify rvm version per project
+# rvmrc_rvm_version="1.14.10 (stable)" # 1.10.1 seams as a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
+#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
+#   return 1
+# }
+
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+  [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]] &&
+    \. "${rvm_path:-$HOME/.rvm}/hooks/after_use" || true
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  rvm --create  "$environment_id" || {
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  }
+fi
+
+# If you use bundler, this might be useful to you:
+# if [[ -s Gemfile ]] && {
+#   ! builtin command -v bundle >/dev/null ||
+#   builtin command -v bundle | GREP_OPTIONS= \grep $rvm_path/bin/bundle >/dev/null
+# }
+# then
+#   printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
+#   gem install bundler
+# fi
+# if [[ -s Gemfile ]] && builtin command -v bundle >/dev/null
+# then
+#   bundle install | GREP_OPTIONS= \grep -vE '^Using|Your bundle is complete'
+# fi

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,40 @@
+PATH
+  remote: .
+  specs:
+    campgrounds (0.0.1)
+      geokit
+      hashie (~> 1)
+      rest-client
+      xml-simple
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.3.2)
+    ansi (1.4.3)
+    crack (0.3.1)
+    geokit (1.6.5)
+      multi_json
+    hashie (1.2.0)
+    mime-types (1.19)
+    multi_json (1.3.6)
+    rake (0.9.2.2)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    turn (0.9.6)
+      ansi
+    vcr (2.2.5)
+    webmock (1.8.11)
+      addressable (>= 2.2.7)
+      crack (>= 0.1.7)
+    xml-simple (1.1.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  campgrounds!
+  rake
+  turn
+  vcr
+  webmock

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Tamera Mitchell
+
+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,64 @@
+# Campgrounds
+
+This is a ruby wrapper for the Active Network [campground API](http://developer.active.com/docs/read/Campground_APIs).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'campgrounds'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install campgrounds
+
+## Usage
+
+If you haven't already, you'll need to [create an account](http://developer.active.com/member/register) with Active Network to get an API key.
+
+For details on the various methods and parameters available, see the comments in the lib/campground files.
+
+## Examples
+
+    campground = Campgrounds.client('yourkey')
+
+#### Campground Search
+Returns campgrounds matching a set of filters. 
+
+Get all campgrounds:
+
+    campground.campground_search.all()
+
+Get campgrounds in Colorado with sites for trailers, water hookups, and fishing nearby:
+
+    campground.campground_search.find({:pstate => 'CO', :siteType => "trailer", :water => true, :amenity => 'fishing'})
+
+Get campgrounds within 50 miles of Boulder, CO that allow pets:
+
+    campground.campground_search.find_by_address("boulder, co", 50, {:pets => true})
+
+
+#### Campground Details
+
+Get the details on a particular campground:
+
+    campground.campground_details.find({:contractCode => 'CO', :parkId => '50032'})
+
+
+#### Campsite Search
+
+Get any sites in a particular campground that are pull-through and offer amp hookups with 20 amps or more:
+
+    campground.campsite_search.find({:contractCode => 'CO', :parkId => '50032', :pull => true, :hookups => "20+"})
+
+## Contributing
+
+1. Fork it
+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,7 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.test_files = FileList['spec/lib/campgrounds/*_spec.rb']
+  t.verbose = true
+end
+task :default => :test

data/campgrounds.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'campgrounds/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "campgrounds"
+  gem.version       = Campgrounds::VERSION
+  gem.authors       = ["Tami Mitchell"]
+  gem.email         = ["mail@tamimitchell.com"]
+  gem.description   = %q{Provide a wrapper for the Active Network campground API}
+  gem.summary       = %q{Provide data on campgrounds in Reserve America's database via the Active Network campground API}
+  gem.homepage      = ""
+
+  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.require_paths = ["lib"]
+
+  gem.add_runtime_dependency 'hashie', '~> 1'
+  gem.add_runtime_dependency 'rest-client'
+  gem.add_runtime_dependency 'xml-simple'
+  gem.add_runtime_dependency 'geokit'
+
+  # testing
+  gem.add_development_dependency 'webmock'
+  gem.add_development_dependency 'vcr'
+  gem.add_development_dependency 'turn'
+  gem.add_development_dependency 'rake'
+end

data/lib/campgrounds/base.rb

@@ -0,0 +1,35 @@
+module Campgrounds
+  class Base
+  include GeoKit::Geocoders
+
+    attr_accessor :api_key
+
+    def initialize(api_key)
+      @api_key = api_key
+    end
+
+    def campground_search
+      @campground_search ||= Campgrounds::CampgroundSearch.new(@api_key)
+    end
+
+    def campground_details
+      @campground_details ||= Campgrounds::CampgroundDetails.new(@api_key)
+    end
+
+    def campsite_search
+      @campsite_search ||= Campgrounds::CampsiteSearch.new(@api_key)
+    end
+
+
+    # private
+
+      def query(path, options={})
+        base_uri  = 'http://api.amp.active.com/camping'
+        options['api_key'] = @api_key
+        url = base_uri + path
+        xml = RestClient.get url, {:params => options}
+        data = XmlSimple.xml_in(xml.to_s, { 'KeyAttr' => 'name' })
+      end
+
+  end
+end

data/lib/campgrounds/campground_details.rb

@@ -0,0 +1,26 @@
+module Campgrounds
+  class CampgroundDetails < Base
+
+    Path = '/campground/details'
+
+    # This find method is here only for consitency of method names at this point. May add more features later.
+    def find(options={})
+      query(Path, options)
+    end
+
+    # Call the Campground Details API, open to use it's default parameters.
+    # 
+    # Required Parameters
+    # -------------------
+    # 
+    # contractCode:
+    # "contractCode" is a syonym for contractID, which is what is returned by the Campground Search API.  It specifies the jurisdiction for the campground.  This parameter must be used in conjuction with parkId.
+    # 
+    # parkId: Facility ID
+    # "parkId" is a synonym for "facilityID", which is returned by the Campground Search API.  It is a unique identifier for the campground. 
+    def request(options={})
+      query(Path, options)
+    end
+
+  end
+end

data/lib/campgrounds/campground_search.rb

@@ -0,0 +1,218 @@
+module Campgrounds
+  class CampgroundSearch < Base
+
+    Path = '/campgrounds'
+
+    # Retrieve all campgrounds.
+    def all
+      query(Path)
+    end
+
+    # A cleaned up version of the request method below. Updated to use strings or boolean values instead of varius numbers.
+    # 
+    # Optional Parameters
+    # -------------------
+    # landmarkLat:
+    # landmarkLong: These two parameters allow for campground searches around a fixed geo-point.
+    # 
+    # siteType:
+    # If unspecified, all site types are returned.
+    #   "rv": RV Sites
+    #   "cabin": Cabins or Lodgings
+    #   "tent": Tent
+    #   "trailer": Trailer
+    #   "group": Group Site
+    #   "day": Day Use
+    #   "horse": Horse Site
+    #   "boat": Boat Site
+    # 
+    # pstate: The two character abbreviation for US state, Canadian province or territory
+    # pname: Park Name
+    # arvDate: Arrival Date
+    # lengthOfStay: When combined with arvDate, this parameter determines how long the camper would like to reserve the campground. 
+    # 
+    # amenity:
+    # Campground Feature. Only one amenity can be specified per query. Specifying amenity=4004, for example, returns campgrounds with fishing.
+    #   Biking  4001
+    #   Boating 4002
+    #   Equipment Rental  4003
+    #   Fishing 4004
+    #   Golf  4005
+    #   Hiking  4006
+    #   Horseback Riding  4007
+    #   Hunting 4008
+    #   Recreational Activities 4009
+    #   Scenic Trails 4010
+    #   Sports  4011
+    #   Beach/Water Activities  4012
+    #   Winter Activities 4013
+    # 
+    # eqpLen: Equipment Length
+    # maxPeople: Number of campers
+    # 
+    # The following params seem to search correctly, though the results such as 'sitesWithAmps' may not return the expected results. It looks like some people put this info in the description field rather than the various Y/N fields.
+    # hookup: Electric Hookup
+    #   "15+": 15 Amps or More
+    #   "20+": 20 Amps or More 
+    #   "30+": 30 Amps or More 
+    #   "50+": 50 Amps or More 
+    # 
+    # water: Water Hookup. Boolean.
+    # sewer: Sewer Hookup. Boolean.
+    # pull: Pull Through Driveway. Boolean.
+    # pets: Pets Allowed. Boolean.
+    # waterfront: Waterfront Sites. Boolean.
+    def find(options={})
+        case options[:siteType]
+            when "rv"
+                options[:siteType] = 2001
+            when "cabin"
+                options[:siteType] = 10001
+            when "tent"
+                options[:siteType] = 2003
+            when "trailer"
+                options[:siteType] = 2002
+            when "group"
+                options[:siteType] = 9002
+            when "day"
+                options[:siteType] = 9001
+            when "horse"
+                options[:siteType] = 3001
+            when "boat"
+                options[:siteType] = 2004
+        end
+
+        case options[:amenity]
+            when "biking"
+                options[:amenity] = 4001
+            when "boating"
+                options[:amenity] = 4002
+            when "equipment rental"
+                options[:amenity] = 4003
+            when "fishing"
+                options[:amenity] = 4004
+            when "golf"
+                options[:amenity] = 4005
+            when "hiking"
+                options[:amenity] = 4006
+            when "horseback riding"
+                options[:amenity] = 4007
+            when "hunting"
+                options[:amenity] = 4008
+            when "recreational activities"
+                options[:amenity] = 4009
+            when "scenic trails"
+                options[:amenity] = 4010
+            when "sports"
+                options[:amenity] = 4011
+            when "beach/water activities"
+                options[:amenity] = 4012
+            when "winter activities"
+                options[:amenity] = 4013
+        end
+
+        case options[:hookup]
+            when "15+"
+                options[:hookup] = 3002
+            when "20+"
+                options[:hookup] = 3003
+            when "30+"
+                options[:hookup] = 3004
+            when "50+"
+                options[:hookup] = 3005
+        end
+
+        options[:water] = 3006 if options[:water]
+        options[:sewer] = 3007 if options[:sewer]
+        options[:pull] = 3008 if options[:pull]
+        options[:pets] = 3010 if options[:pets]
+        options[:waterfront] = 3011 if options[:waterfront]
+
+        # Might return results array at some point, but returning the wrapper for now to keep results similar to default.
+        return query(Path, options)
+    end
+
+    # Search for campgrounds with an address string and optional range in miles. The address could be a street address, city and state, etc.
+    # Uses the find method so you can pass strings/booleans
+    def find_by_address(address, range=1000, options={})
+        coords = MultiGeocoder.geocode(address)
+        options[:landmarkName] = true
+        options[:landmarkLat] = coords.lat
+        options[:landmarkLong] = coords.lng
+
+        results = find(options)
+
+        results['result'].each do |c|
+            lat = c['latitude']
+            long = c['longitude']
+            c['distance'] = coords.distance_to([lat,long])
+        end
+        results['result'].delete_if {|k, v| k['distance'] >= range }
+
+        return results
+    end
+
+    # Call the Campground Search API, open to use it's default parameters.
+    # 
+    # Optional Parameters
+    # -------------------
+    # 
+    # landmarkLat:
+    # landmarkLong: These two parameters allow for campground searches around a fixed geo-point.
+    # 
+    # siteType:
+    # If unspecified, all site types are returned.
+    #   RV Sites  2001
+    #   Cabins or Lodgings  10001
+    #   Tent  2003
+    #   Trailer 2002
+    #   Group Site  9002
+    #   Day Use 9001
+    #   Horse Site  3001
+    #   Boat Site 2004
+    # 
+    # pstate: The two character abbreviation for US state, Canadian province or territory
+    # pname: Park Name
+    # arvdate: Arrival Date
+    # lengthOfStay: When combined with arvdate, this parameter determines how long the camper would like to reserve the campground. 
+    # 
+    # amenity:
+    # Campground Feature. Only one amenity can be specified per query. Specifying amenity=4004, for example, returns campgrounds with fishing.
+    #   Biking  4001
+    #   Boating 4002
+    #   Equipment Rental  4003
+    #   Fishing 4004
+    #   Golf  4005
+    #   Hiking  4006
+    #   Horseback Riding  4007
+    #   Hunting 4008
+    #   Recreational Activities 4009
+    #   Scenic Trails 4010
+    #   Sports  4011
+    #   Beach/Water Activities  4012
+    #   Winter Activities 4013
+    # 
+    # eqlen: Equipment Length
+    # Maxpeople: Number of campers
+    # 
+    # hookup: Electric Hookup
+    #   15 Amps or More 3002
+    #   20 Amps or More 3003
+    #   30 Amps or More 3004
+    #   50 Amps or More 3005
+    # 
+    # water: Water Hookup. Specify &water=3007 to search for campgrounds with water hookups.
+    # sewer: Sewer Hookup. Specify &sewer=3007 to search for campgrounds with sewer hookups.
+    # pull: Pull Through Driveway. Specify &pull=3008 to search for campgrounds with pull through driveways.
+    # pets: Pets Allowed. Specify &pets=3010 to search for campgrounds where pets are allowed.
+    # waterfront: Waterfront Sites. Specify &waterfront=3011 to search for campgrounds with waterfront campsites.
+
+
+    def request(options={})
+      query(Path, options)
+    end
+
+
+
+  end
+end

data/lib/campgrounds/campsite_search.rb

@@ -0,0 +1,138 @@
+module Campgrounds
+  class CampsiteSearch < Base
+
+    Path = '/campsites'
+
+
+    # A cleaned up version of the request method below. Updated to use strings or boolean values instead of varius numbers.
+    # Required Parameters
+    # -------------------
+    # 
+    # contractCode: 
+    # "contractCode" is a syonym for contractID, which is what is returned by the Campground Search API.  It specifies the jurisdiction for the campground.  This parameter must be used in conjuction with parkId.
+    # 
+    # parkId: Facility ID
+    # "parkId" is a synonym for "facilityID", which is returned by the Campground Search API.  It is a unique identifier for the campground. 
+    # 
+    # 
+    # Optional Parameters
+    # -------------------
+    # siteType:
+    # If unspecified, all site types are returned.
+    #   "rv": RV Sites
+    #   "cabin": Cabins or Lodgings
+    #   "tent": Tent
+    #   "trailer": Trailer
+    #   "group": Group Site
+    #   "day": Day Use
+    #   "horse": Horse Site
+    #   "boat": Boat Site
+    # 
+    # arvDate: Arrival Date
+    # lengthOfStay: When combined with arvDate, this parameter determines how long the camper would like to reserve the campground. 
+    # eqpLen: Equipment Length
+    # maxPeople: Number of campers
+    # 
+    # hookup: Electric Hookup
+    #   "15+": 15 Amps or More
+    #   "20+": 20 Amps or More 
+    #   "30+": 30 Amps or More 
+    #   "50+": 50 Amps or More 
+    # 
+    # water: Water Hookup. Boolean.
+    # sewer: Sewer Hookup. Boolean.
+    # pull: Pull Through Driveway. Boolean.
+    # pets: Pets Allowed. Boolean.
+    # waterfront: Waterfront Sites. Boolean.
+    def find(options={})
+        case options[:siteType]
+            when "rv"
+                options[:siteType] = 2001
+            when "cabin"
+                options[:siteType] = 10001
+            when "tent"
+                options[:siteType] = 2003
+            when "trailer"
+                options[:siteType] = 2002
+            when "group"
+                options[:siteType] = 9002
+            when "day"
+                options[:siteType] = 9001
+            when "horse"
+                options[:siteType] = 3001
+            when "boat"
+                options[:siteType] = 2004
+        end
+
+        case options[:hookup]
+            when "15+"
+                options[:hookup] = 3002
+            when "20+"
+                options[:hookup] = 3003
+            when "30+"
+                options[:hookup] = 3004
+            when "50+"
+                options[:hookup] = 3005
+        end
+
+        options[:water] = 3006 if options[:water]
+        options[:sewer] = 3007 if options[:sewer]
+        options[:pull] = 3008 if options[:pull]
+        options[:pets] = 3010 if options[:pets]
+        options[:waterfront] = 3011 if options[:waterfront]
+
+        # Might return results array at some point, but returning the wrapper for now to keep results similar to default.
+        return query(Path, options)
+    end
+
+    # Call the Campsite Search API, open to use it's default parameters.
+    # 
+    # Required Parameters
+    # -------------------
+    # 
+    # contractCode: 
+    # "contractCode" is a syonym for contractID, which is what is returned by the Campground Search API.  It specifies the jurisdiction for the campground.  This parameter must be used in conjuction with parkId.
+    # 
+    # parkId: Facility ID
+    # "parkId" is a synonym for "facilityID", which is returned by the Campground Search API.  It is a unique identifier for the campground. 
+    # 
+    # 
+    # Optional Parameters
+    # -------------------
+    # siteType:
+    # If unspecified, all site types are returned.
+    #   RV Sites  2001
+    #   Cabins or Lodgings  10001
+    #   Tent  2003
+    #   Trailer 2002
+    #   Group Site  9002
+    #   Day Use 9001
+    #   Horse Site  3001
+    #   Boat Site 2004
+    # 
+    # arvDate: Arrival Date
+    # lengthOfStay: When combined with arvdate, this parameter determines how long the camper would like to reserve the campground. 
+    # eqpLen: Equipment Length
+    # maxPeople: Number of campers
+    # 
+    # hookup: Electric Hookup
+    #   15 Amps or More 3002
+    #   20 Amps or More 3003
+    #   30 Amps or More 3004
+    #   50 Amps or More 3005
+    # 
+    # water: Water Hookup. Specify &water=3006 to search for campgrounds with water hookups.
+    # sewer: Sewer Hookup. Specify &sewer=3007 to search for campgrounds with sewer hookups.
+    # pull: Pull Through Driveway. Specify &pull=3008 to search for campgrounds with pull through driveways.
+    # pets: Pets Allowed. Specify &pets=3010 to search for campgrounds where pets are allowed.
+    # waterfront: Waterfront Sites. Specify &waterfront=3011 to search for campgrounds with waterfront campsites.
+
+
+    def request(options={})
+      query(Path, options)
+    end
+
+
+
+  end
+end

data/lib/campgrounds/version.rb

@@ -0,0 +1,3 @@
+module Campgrounds
+  VERSION = "0.0.1"
+end

data/lib/campgrounds.rb

@@ -0,0 +1,20 @@
+require "campgrounds/version"
+
+require 'hashie'
+require 'xmlsimple'
+require 'rest_client'
+require 'geokit'
+
+require_relative 'campgrounds/base.rb'
+require_relative 'campgrounds/campground_search.rb'
+require_relative 'campgrounds/campground_details.rb'
+require_relative 'campgrounds/campsite_search'
+
+module Campgrounds
+
+  class << self
+    def client(key)
+      Campgrounds::Base.new(key)
+    end
+  end
+end