supercamp 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8febad2fae0ba82c928a3fde98a0e6032d9f14b6
-  data.tar.gz: 2641fdcc51a40cf1755a1da6f97930386a9654e5
+  metadata.gz: dba108960b355a8c635e29d37344a702a874dc0f
+  data.tar.gz: 103109c66ecc53341bb04cba71cbeee82a9e9260
 SHA512:
-  metadata.gz: 2351f837d0c80a1be178bfe9c3d45c264284361f8e576b52b437feabcc1e274edfcd68f883ffdf306fbaa88b98c792812cd4083ca1e5b8bf620a0f36c5f05cc2
-  data.tar.gz: 3f5ef2f2617a53108c8dfa98776c81fdae8a7a4d0fce59d721d69fbab52169341746dc3b1d0a92a12a32fc629bfde28571816a52577747eb1fff7777b0138c1e
+  metadata.gz: 36927842aa84a87d326430316d7bd5a67e26d838d4a5d1b684fabe217dca42a8d0a82f8b100381e5a981443d33d0831b09936492c8e276ac3ec049fef9ddb5dd
+  data.tar.gz: 9627ec1aa2954199a813208e4f4b42099ea07c1104be9ff95cd1edf64895cfdad588de778b81be8f0f2d0057549fea73768a28616768989fcdc4ef3f86681863

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.4

data/Gemfile

@@ -2,3 +2,9 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in supercamp.gemspec
 gemspec
+
+gem "rake"
+
+group :test do
+  gem "coveralls", "~> 0.7.0", require: false
+end

data/README.md

@@ -1,31 +1,79 @@
-# Supercamp
+Supercamp [![Build Status](https://travis-ci.org/davekrupinski/supercamp.svg?branch=master)](https://travis-ci.org/davekrupinski/supercamp.svg?branch=master) [![Coverage Status](https://img.shields.io/coveralls/davekrupinski/supercamp.svg)](https://coveralls.io/r/davekrupinski/supercamp?branch=master)
+============
 
-TODO: Write a gem description
+Wrapper for the Active Network Campground API, and probably a bad Supertramp joke at the same time.
 
-## Installation
+Installation
+------------
 
-Add this line to your application's Gemfile:
+Add to your Gemfile:
 
 ```ruby
 gem 'supercamp'
 ```
 
-And then execute:
+Configuration
+------------
+The only required configuration setting is a valid API KEY for Active Network's Campground API.  These can be obtained by registering at http://developer.active.com/docs/read/Campground_APIs
 
-    $ bundle
+```ruby
+Supercamp.configure do |config|
+    config.api_key = "YOUR-API-KEY"
+end
+```
+Additionally, a custom timeout span can be given.  The default is 5 seconds.
+```ruby
+Supercamp.configure do |config|
+    config.api_key = "YOUR-API-KEY"
+    config.timeout = 10
+end
+```
+
+General Usage
+------------
 
-Or install it yourself as:
+The wrapper supports all 3 of the API endpoints:
+* Campgrounds
+* Campsites
+* Details
+
+Each service implements a search interface that can be used as chainable methods or a block search.
+```ruby
+Supercamp.campgrounds.state("CA").amenity(:biking)
+```
+-- or --
+```ruby
+Supercamp.campgrounds.search do
+    state   "CA"
+    amenity "biking"
+    has     "water", :pets, "sewer"
+end
+```
 
-    $ gem install supercamp
+## Campsite API
 
-## Usage
+The campgrounds interface supports:
+* **site_type** (rv, cabin, lodging, tent, trailer, group_site, day_use, horse_site, or boat_site)
+* **arrival** (mm/dd/yyyy)
+* **nights** (integer) *used with *arrival* to specify duration of stay*
+* **min_equip_length** (feet)
+* **people** (integer)
+* **min_elec_amps** (15, 20, 30, or 50)
 
-TODO: Write usage instructions here
+## Camground API
+Supports all options from **Campsite API** with additional support for:
+* **geo** (lat, long)
+* **state** (string) *2 character abbreviation*
+* **name** (string) *Name of Park*
+* **amenity** (biking, boating, equipment_rentals, fishing, golf, hiking, horseback_riding, hunting, rec_activities, scenic_trails, sports, beach_or_water, or winter_activities)
+* **has** (Multiple: water, sewer, pull, pets, waterfront)
 
-## Contributing
+## Details API
+##### Note: Both Parameters are Required
+* **contract_code** (string) *contract_id returned from Campground API Search*
+* **id** (string) *facility_id returned from Campground API Search*
 
-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
+## TODO
+* Configuration Validation
+* Search Parameter Validation
+* Search Lookup Caching

data/Rakefile

@@ -4,7 +4,7 @@ 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']
+  task.rspec_opts = ['--color', '--format', 'documentation']
 end
 
 task default: :spec

data/lib/supercamp/criteria/campground.rb

@@ -46,8 +46,8 @@ module Supercamp
       # the API performs a string-match query for parks containing 
       # the character string specified. 
       #
-      def name(city)
-        merge_option(:pname, city)
+      def name(park)
+        merge_option(:pname, park)
         self
       end
 

data/lib/supercamp/version.rb

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

data/spec/spec_helper.rb

@@ -3,6 +3,9 @@ require 'supercamp'
 require 'vcr'
 require 'dotenv'
 
+require 'coveralls'
+Coveralls.wear!
+
 RSpec.configure do |config|
 
   Dotenv.load

data/supercamp.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "typhoeus", "~> 0.6.0"
-  spec.add_dependency "oga",      "~> 0.1.0"
+  spec.add_dependency "oga",      "~> 0.2.0"
   spec.add_dependency "hashr",    "~> 0.0.0"
 
   spec.add_development_dependency "bundler", "~> 1.7"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: supercamp
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Dave Krupinski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-17 00:00:00.000000000 Z
+date: 2014-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: hashr
   requirement: !ruby/object:Gem::Requirement
@@ -143,9 +143,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".coveralls.yml"
 - ".gitignore"
 - ".rspec"
 - ".rvmrc"
+- ".travis.yml"
 - Gemfile
 - Guardfile
 - LICENSE.txt