teleportd 0.0.4 → 0.1.0

data/README.md

@@ -25,13 +25,9 @@ NOTE: You must set an ENV variable 'TELEPORTD_API_KEY' for your Teleportd API ke
 
     $ 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
+Create an instance of a Teleportd::Search with optional filters.  The
+Search returns an enumerable collection of Teleportd::SearchResult
+objects
 
 Query With Locations:
 

data/lib/teleportd.rb

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

data/lib/teleportd/search.rb

@@ -1,5 +1,6 @@
 module Teleportd
   class Search
+    include Enumerable
 
     class << self
       def potential_available_filters
@@ -10,15 +11,23 @@ module Teleportd
     attr_reader :opts
 
     def initialize opts={}
-      @opts = opts
+      @opts    = opts
       @request = Request.new(request_uri)
     end
 
-    def result
-      @request.parsed_response
+    def results
+      @results ||= parsed_response["hits"].map{|r|SearchResult.new(r)}
+    end
+
+    def each
+      results.each {|member| yield member}
     end
 
     private
+    def parsed_response
+      @request.parsed_response
+    end
+
     def request_uri
       available_filters.each_with_object(base_request_uri) do |filter, uri|
         uri << "&#{self.send(filter)}"
@@ -63,7 +72,7 @@ module Teleportd
     def time_period
       return nil unless has_time_search?
       begin_period = opts[:time_period][:start_time].to_i
-      end_period = opts[:time_period][:end_time].to_i
+      end_period   = opts[:time_period][:end_time].to_i
       "period=[#{begin_period},#{end_period}]"
     end
 

data/lib/teleportd/search_result.rb

@@ -0,0 +1,110 @@
+module Teleportd
+  # Represents an individual image returned from a Search call
+  class SearchResult
+
+    # @api private
+    attr_reader :result_hash
+
+    # Accepts a hash from a Teleportd::Search and returns an instance of Teleportd::SearchResult
+    #
+    # @example
+    #     Teleportd::SearchResult.new(result_hash)
+    #     > #<Teleportd::SearchResult...>
+    #
+    # @param [Hash]
+    # @return [Teleportd::SearchResult]
+    def initialize result_hash={}
+      @result_hash = result_hash
+    end
+
+    # Returns a Hash with the results latitude and longitude values
+    #
+    # @return [Hash]
+    def location
+      result_hash['loc']
+    end
+
+    # Returns a String representing the search result type (usually "image")
+    #
+    # @return [String]
+    def type
+      result_hash['typ']
+    end
+
+    # Returns a String representing the search result SHA hash
+    #
+    # @return [String]
+    def sha
+      result_hash['sha']
+    end
+
+    # Returns the result's time as seconds from the epoch
+    #
+    # @return [Fixnum]
+    def date
+      result_hash['dte']
+    end
+
+    # Returns the source of the result ("twimg", "instagram", etc.)
+    #
+    # @return [String]
+    def source
+      result_hash['src']
+    end
+
+    # Returns the thumbnail image url for the result
+    #
+    # @return [String]
+    def thumbnail_url
+      result_hash['thb']
+    end
+
+    # Returns the full resolution image url for the result
+    #
+    # @return [String]
+    def full_resolution_url
+      result_hash['fll']
+    end
+
+    # Returns the author handles identified from the result
+    # NOTE: Will return nil unless you have an enterprise account
+    #
+    # @return [Array]
+    def users
+      result_hash['usr']
+    end
+
+    # Returns the user's profile pic url from the respective service account
+    # NOTE: Will return nil unless you have an enterprise account
+    #
+    # @return [String]
+    def profile_pic_url
+      result_hash['pic']
+    end
+
+    # Returns the comments or title of the search result in an Array
+    # NOTE: Will return nil unless you have an enterprise account
+    #
+    # @return [Array]
+    def text
+      result_hash['text']
+    end
+
+    # Returns the hashtags of the search result in an Array
+    # NOTE: Will return nil unless you have an enterprise account
+    #
+    # @return [Array]
+    def hashtags
+      result_hash['hashtag']
+    end
+
+    # Returns the mentions of the search result in an Array
+    # NOTE: Will return nil unless you have an enterprise account
+    #
+    # @return [Array]
+    def mentions
+      result_hash['mention']
+    end
+
+  end
+end

data/lib/teleportd/version.rb

@@ -1,3 +1,3 @@
 module Teleportd
-  VERSION = "0.0.4"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: teleportd
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-29 00:00:00.000000000 Z
+date: 2012-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &7591140 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,15 @@ dependencies:
         version: 1.7.1
   type: :runtime
   prerelease: false
-  version_requirements: *7591140
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.1
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &7590620 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +37,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *7590620
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &7589940 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +53,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *7589940
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: curb
-  requirement: &7589340 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +69,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *7589340
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &7588680 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +85,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *7588680
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Ruby Wrapper Library for Teleportd API
 email:
 - nicholas.fine@gmail.com
@@ -82,6 +107,7 @@ files:
 - lib/teleportd/config.rb
 - lib/teleportd/request.rb
 - lib/teleportd/search.rb
+- lib/teleportd/search_result.rb
 - lib/teleportd/version.rb
 - teleportd.gemspec
 homepage: ''
@@ -104,7 +130,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Ruby Wrapper Library for Teleportd API