supercamp 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8febad2fae0ba82c928a3fde98a0e6032d9f14b6
+  data.tar.gz: 2641fdcc51a40cf1755a1da6f97930386a9654e5
+SHA512:
+  metadata.gz: 2351f837d0c80a1be178bfe9c3d45c264284361f8e576b52b437feabcc1e274edfcd68f883ffdf306fbaa88b98c792812cd4083ca1e5b8bf620a0f36c5f05cc2
+  data.tar.gz: 3f5ef2f2617a53108c8dfa98776c81fdae8a7a4d0fce59d721d69fbab52169341746dc3b1d0a92a12a32fc629bfde28571816a52577747eb1fff7777b0138c1e

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/.env
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.DS_Store

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rvmrc

@@ -0,0 +1,53 @@
+#!/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 2.1.4@supercamp" > .rvmrc
+environment_id="ruby-2.1.4@supercamp"
+
+# Uncomment the following lines if you want to verify rvm version per project
+# rvmrc_rvm_version="1.26.0 (master)" # 1.10.1 seems like a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | __rvm_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"
+  for __hook in "${rvm_path:-$HOME/.rvm}/hooks/after_use"*
+  do
+    if [[ -f "${__hook}" && -x "${__hook}" && -s "${__hook}" ]]
+    then \. "${__hook}" || true
+    fi
+  done
+  unset __hook
+  if (( ${rvm_use_flag:=1} >= 2 )) # display only when forced
+  then
+    if [[ $- == *i* ]] # check for interactive shells
+    then printf "%b" "Using: $(tput setaf 2 2>/dev/null)$GEM_HOME$(tput sgr0 2>/dev/null)
+" # show the user the ruby and gemset they are using in green
+    else printf "%b" "Using: $GEM_HOME
+" # don't use colors in non-interactive shells
+    fi
+  fi
+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="" 

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,16 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rsspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separetly)
+#  * 'just' rspec: 'rspec'
+guard :rspec, cmd: 'bundle exec rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Dave Krupinski
+
+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,31 @@
+# Supercamp
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'supercamp'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install supercamp
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/supercamp/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 a new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+
+# Default directory to look in is `/specs`
+# Run with `rake spec`
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--color', '--format', 'nested']
+end
+
+task default: :spec

data/lib/supercamp/configuration.rb

@@ -0,0 +1,22 @@
+module Supercamp
+
+  class Configuration
+
+    attr_accessor :api_key
+    attr_accessor :timeout
+
+    def initialize
+      @timeout ||= 5
+    end
+
+    def configure
+      yield self
+    end
+
+    def base_url
+      "http://api.amp.active.com/camping"
+    end
+
+  end
+
+end

data/lib/supercamp/criteria/abstract.rb

@@ -0,0 +1,53 @@
+module Supercamp
+  module Criteria
+
+    class Abstract
+      
+      attr_accessor :options
+
+      def initialize(&block)
+        @options = {}
+        instance_eval(&block) if block_given?
+      end
+
+      class << self
+
+        def search(&block)
+          new &block
+        end
+
+      end
+
+      def search(&block)
+        self.class.search &block
+      end
+
+      def endpoint
+        name = self.class.to_s.split("::").last.downcase
+        "#{Supercamp.config.base_url}/#{name}s"
+      end
+
+      def query
+        opts = { api_key: Supercamp.config.api_key }.merge(options)
+        Typhoeus::Request.new(endpoint, timeout: Supercamp.config.timeout, params: opts)
+      end
+
+      def response(query=query)
+        response = query.run
+        if response.code == 200
+          Supercamp::Response.new response
+        else
+          raise Supercamp::Error.new self, response
+        end
+      end
+
+    private
+
+      def merge_option(key, value)
+        @options[key.to_s] = value
+      end
+
+    end
+
+  end
+end

data/lib/supercamp/criteria/campground.rb

@@ -0,0 +1,87 @@
+module Supercamp
+  module Criteria
+
+    class Campground < Campsite
+
+      AMENITIES = {
+        "biking"    => 4001,
+        "boating"   => 4002,
+        "equipment_rentals" => 4003,
+        "fishing"   => 4004,
+        "golf"      => 4005,
+        "hiking"    => 4006,
+        "horseback_riding" => 4007,
+        "hunting"   => 4008,
+        "rec_activities" => 4009,
+        "scenic_trails" => 4010,
+        "sports"    => 4011,
+        "beach_or_water" => 4012,
+        "winter_activities" => 4013
+      }
+
+      # landmarkLat, landmarkLong (latitude/longitude)
+      # 
+      # These two parameters allow for campground searches around a fixed geo-point.
+      #
+      def geo(lat, lng)
+        merge_option("landmarkLat", lat)
+        merge_option("landmarkLong", lng)
+        self
+      end
+
+
+      # pstate: State or Province
+      #
+      # The two character abbreviation for US state 
+      #
+      def state(abbr)
+        merge_option(:pstate, abbr)
+        self
+      end
+
+
+      # pname: Park Name
+      #
+      # The name of the park.  When this parameter is specified, 
+      # the API performs a string-match query for parks containing 
+      # the character string specified. 
+      #
+      def name(city)
+        merge_option(:pname, city)
+        self
+      end
+
+
+      # amenity: Campground Feature
+      #
+      # There are all sorts of things to do at campgrounds.
+      # Only one amenity can be specified per query.
+      #
+      def amenity(key)
+        code = AMENITIES.fetch(key.to_s)
+        merge_option(:amenity, code)
+        self
+      end
+
+
+      # has: Campture Features
+      #
+      # Specify 1 or more optional perks:
+      # # water     
+      # # sewer     
+      # # pull      
+      # # pets      
+      # # waterfront
+      #
+      def has(*perks)
+        perks.each do |perk|
+          next unless PERKS.has_key?(perk.to_s)
+          merge_option(perk, PERKS[perk.to_s])
+        end
+        self
+      end
+
+    end
+
+  end
+end

data/lib/supercamp/criteria/campsite.rb

@@ -0,0 +1,99 @@
+module Supercamp
+  module Criteria
+
+    class Campsite < Abstract
+
+      TYPES = {
+        "rv"          => 2001,
+        "cabin"       => 10001,
+        "lodging"     => 10001,
+        "tent"        => 2003,
+        "trailer"     => 2002,
+        "group_site"  => 9002,
+        "day_use"     => 9001,
+        "horse_site"  => 3001,
+        "boat_site"   => 2004
+      }
+
+      PERKS = {
+        "water"       => 3007,
+        "sewer"       => 3007, 
+        "pull"        => 3008,
+        "pets"        => 3010,
+        "waterfront"  => 3011
+      }
+
+      ELECTRIC_HOOKUPS = {
+        "15" => 3002,
+        "20" => 3003,
+        "30" => 3004,
+        "50" => 3005
+      }
+
+
+      # siteType
+      # 
+      # If unspecified, all site types are returned.
+      #
+      def site_type(name)
+        code = TYPES.fetch(name.to_s)
+        merge_option("siteType", code)
+        self
+      end
+
+
+      # arvdate: Arrival Date
+      #
+      # The date in which the camper wants to start camping in mm/dd/yyyy format.
+      #
+      def arrival(date)
+        merge_option(:arvdate, date)
+        self
+      end
+
+
+      # lengthOfStay: Length of Stay
+      #
+      # When combined with arvdate, this parameter determines how long 
+      # the camper would like to reserve the campground. 
+      #
+      def nights(amt)
+        merge_option("lengthOfStay", amt)
+        self
+      end
+
+
+      # eqplen: Equipment Length
+      #
+      # If the camper wants to find campgrounds where his 50 foot RV will fit, 
+      # issue a query where eqplen=50
+      #
+      def min_equip_length(val)
+        merge_option("eqplen", val)
+        self
+      end
+
+      
+      # Maxpeople: Number of campers
+      #
+      #
+      def people(amt)
+        merge_option("Maxpeople", amt)
+        self
+      end
+
+
+      # hookup: Electric Hookup
+      #
+      #
+      def min_elec_amps(val)
+        code = ELECTRIC_HOOKUPS.fetch(val.to_s)
+        merge_option(:hookup, code)
+        self
+      end
+
+
+    end
+
+  end
+end

data/lib/supercamp/criteria/detail.rb

@@ -0,0 +1,31 @@
+module Supercamp
+  module Criteria
+
+    class Detail < Abstract
+
+      # contractCode: STATE, FEDERAL or PRIVATE
+
+      # "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
+      #
+      def contract_code(type)
+        merge_option("contractCode", type)
+        self
+      end
+
+
+      # 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 id(val)
+        merge_option("parkId", val)
+        self
+      end
+
+    end
+
+  end
+end

data/lib/supercamp/error.rb

@@ -0,0 +1,18 @@
+module Supercamp
+
+  class Error < StandardError
+
+    attr_reader :code
+    attr_reader :api_code
+    attr_reader :criteria
+
+    def initialize(criteria, response)
+      @code     = response.options[:code]
+      @api_code = response.options[:headers]["X-Mashery-Error-Code"]
+      @criteria = criteria
+      super(response.body)
+    end
+
+  end
+
+end

data/lib/supercamp/response.rb

@@ -0,0 +1,41 @@
+require 'oga'
+require 'hashr'
+
+module Supercamp
+
+  class Response
+
+    attr_reader :count
+    attr_reader :entries
+
+    def initialize(response)
+      p = parse_response(response.body)
+
+      set_results_count(p)
+      set_entries(p)
+    end
+
+
+  private
+
+    def parse_response(xml)
+      xml.gsub!("\n", "")
+      Oga.parse_xml(xml).xpath("resultset").first
+    end
+
+    def set_results_count(parsed)
+      @count = parsed.attribute("count").value.to_i
+    end
+
+    def set_entries(parsed)
+      @entries = parsed.children.map do |child|
+        child.attributes.inject(Hashr.new) do |h, attr|
+          key = attr.name.gsub(/(.)([A-Z])/,'\1_\2').downcase
+          h[key] = attr.value; h
+        end
+      end
+    end
+
+  end
+
+end

data/lib/supercamp/version.rb

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

data/lib/supercamp.rb

@@ -0,0 +1,35 @@
+require 'typhoeus'
+
+require 'supercamp/configuration'
+require 'supercamp/error'
+require 'supercamp/response'
+require 'supercamp/version'
+require 'supercamp/criteria/abstract'
+require 'supercamp/criteria/campsite'
+require 'supercamp/criteria/campground'
+require 'supercamp/criteria/detail'
+
+module Supercamp
+  extend self
+
+  def config
+    @config ||= Configuration.new
+  end
+
+  def configure
+    yield config
+  end
+
+  def campsites
+    Supercamp::Criteria::Campsite.new
+  end
+
+  def campgrounds
+    Supercamp::Criteria::Campground.new
+  end
+
+  def details
+    Supercamp::Criteria::Detail.new
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+require 'rubygems'
+require 'supercamp'
+require 'vcr'
+require 'dotenv'
+
+RSpec.configure do |config|
+
+  Dotenv.load
+
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  Supercamp.configure do |c|
+    c.api_key = ENV["API_KEY"]
+  end
+
+  VCR.configure do |c|
+    c.cassette_library_dir = 'spec/vcr_cassettes'
+    c.hook_into :typhoeus
+  end
+
+end

data/spec/supercamp/configuration_spec.rb

@@ -0,0 +1,59 @@
+require "spec_helper"
+
+describe Supercamp::Configuration do
+
+  describe "#configure" do
+
+    context "w/ valid settings" do
+
+      before do
+        subject.configure do |config|
+          config.api_key  = "super"
+          config.timeout  = 10
+        end
+      end
+
+      it { expect(subject.api_key).to eq "super" }
+      it { expect(subject.timeout).to eq 10 }
+
+    end
+
+    context "w/ invalid settings" do
+
+      it do
+        expect {
+          subject.configure do |config|
+            config.crabs    = "super"
+          end
+        }.to raise_error NoMethodError
+      end
+
+    end
+
+  end
+  
+
+  describe "#base_url" do
+
+    it { expect(subject.base_url).to eq "http://api.amp.active.com/camping" }
+
+  end
+
+
+  describe "#api_key" do
+
+    it "defaults to nil" do
+      expect(subject.api_key).to be_nil
+    end
+
+  end
+
+
+  describe "#timeout" do
+
+    it "defaults to 5 (seconds)" do
+      expect(subject.timeout).to eq 5
+    end
+  end
+
+end