teleportd 0.0.1 → 0.0.2

data/README.md

@@ -2,6 +2,8 @@
 
 Ruby Wrapper Library for Teleportd API
 
+Currently, this wrapper only supports the basic search functionality.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -18,7 +20,41 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+NOTE: You must set an ENV variable 'TELEPORTD_API_KEY' for your Teleportd API key
+
+    $ export TELEPORTD_API_KEY=$APIKEY
+
+Create an instance of a Teleportd::Search with optional filters.  Call
+the result method on the Search instance to receive a Hash of the
+search.
+
+Basic Query Without Filters:
+
+    $ search = Teleportd::Search.new
+
+Query With Locations:
+
+    $ options = {}
+    $ options[:location] = {}
+    $ options[:location][:latitude] = 34.19
+    $ options[:location][:longitude] = -119.49
+    $ options[:location][:vertical] = 5.0
+    $ options[:location][:horizontal] = 5.0
+    $ search = Teleportd::Search.new(options)
+
+Query With Textual Search:
+
+    $ options = {}
+    $ options[:textual_search] = 'foo bar baz'
+    $ search = Teleportd::Search.new(options)
+
+Query With Time Period (start/end)
+    
+    $ options = {}
+    $ options[:time_period] = {}
+    $ options[:time_period][:start_time] = 5.days.ago
+    $ options[:time_period][:end_time] = 2.days.ago
+    $ search = Teleportd::Search.new(options)
 
 ## Contributing
 

data/lib/teleportd.rb

@@ -5,7 +5,6 @@ require 'teleportd/version'
 require 'teleportd/config'
 require 'teleportd/request'
 require 'teleportd/search'
-require 'teleportd/stream'
 
 module Teleportd
 end

data/lib/teleportd/search.rb

@@ -1,7 +1,12 @@
-require 'pry'
 module Teleportd
   class Search
 
+    class << self
+      def potential_available_filters
+        [:location, :textual_search, :time_period, :size_filter, :from_filter, :sort_filter]
+      end
+    end
+
     attr_reader :opts
 
     def initialize opts={}
@@ -25,7 +30,7 @@ module Teleportd
     end
 
     def available_filters
-      [:location, :textual_search, :time_period, :size_filter, :from_filter, :sort_filter].each_with_object([]) do |filter, available|
+      Search.potential_available_filters.each_with_object([]) do |filter, available|
         available << filter unless self.send(filter).nil?
       end
     end

data/lib/teleportd/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: teleportd
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &15312040 !ruby/object:Gem::Requirement
+  requirement: &11881640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 1.7.1
   type: :runtime
   prerelease: false
-  version_requirements: *15312040
+  version_requirements: *11881640
 - !ruby/object:Gem::Dependency
   name: active_support
-  requirement: &15311460 !ruby/object:Gem::Requirement
+  requirement: &11881060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *15311460
+  version_requirements: *11881060
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &15310740 !ruby/object:Gem::Requirement
+  requirement: &11880340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *15310740
+  version_requirements: *11880340
 - !ruby/object:Gem::Dependency
   name: curb
-  requirement: &15310120 !ruby/object:Gem::Requirement
+  requirement: &11879720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *15310120
+  version_requirements: *11879720
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &15309460 !ruby/object:Gem::Requirement
+  requirement: &11879060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *15309460
+  version_requirements: *11879060
 description: Ruby Wrapper Library for Teleportd API
 email:
 - nicholas.fine@gmail.com