evrythng 0.0.3 → 0.0.5

data/.gitignore

@@ -0,0 +1,11 @@
+*.gem
+*.rbc
+.DS_Store
+.bundle
+.rvmrc
+.yardoc
+Gemfile.lock
+coverage/*
+doc/*
+log/*
+pkg/*

data/Gemfile

@@ -0,0 +1,7 @@
+source 'http://rubygems.org'
+
+platforms :jruby do
+  gem 'jruby-openssl', '~> 0.7'
+end
+
+gemspec

data/evrythng.gemspec

@@ -16,13 +16,18 @@ Gem::Specification.new do |s|
   s.platform     = Gem::Platform::RUBY
   s.require_path = 'lib'
 
-  s.add_development_dependency('yard', '~> 0.6')
+  s.add_development_dependency 'maruku', '~> 0.6'
+  s.add_development_dependency 'nokogiri', '~> 1.4'
+  s.add_development_dependency 'rake', '~> 0.9'
+  s.add_development_dependency 'rspec', '~> 2.6'
+  s.add_development_dependency 'simplecov', '~> 0.4'
+  s.add_development_dependency 'webmock', '~> 1.7'
+  s.add_development_dependency 'yard', '~> 0.7'
+  s.add_development_dependency 'ZenTest', '~> 4.5'
 
-  s.add_runtime_dependency 'hashie', '~> 1.0.0'
-  s.add_runtime_dependency 'faraday', '~> 0.6.1'
-  s.add_runtime_dependency 'faraday_middleware', '~> 0.6.3'
+  s.add_runtime_dependency 'hashie', '~> 1.1.0'
+  s.add_runtime_dependency 'faraday', '~> 0.7.4'
+  s.add_runtime_dependency 'faraday_middleware', '~> 0.7.0'
   s.add_runtime_dependency 'multi_json', '~> 1.0.0'
-  s.add_runtime_dependency 'multi_xml', '~> 0.2.0'
-  s.add_runtime_dependency 'rash', '~> 0.3.0'
   s.add_runtime_dependency 'simple_oauth', '~> 0.1.5'
 end

data/lib/evrythng/api.rb

@@ -1,10 +1,15 @@
+require 'evrythng/authentication'
+require 'evrythng/configuration'
 require 'evrythng/connection'
 require 'evrythng/request'
-require 'evrythng/authentication'
 
 module Evrythng
   # @private
   class API
+    include Connection
+    include Request
+    include Authentication
+
     # @private
     attr_accessor *Configuration::VALID_OPTIONS_KEYS
 
@@ -15,9 +20,5 @@ module Evrythng
         send("#{key}=", options[key])
       end
     end
-
-    include Connection
-    include Request
-    include Authentication
   end
 end

data/lib/evrythng/client/collections.rb

@@ -8,7 +8,7 @@ module Evrythng
       # @authenticated true
       # @rate_limited true
       # @param options [Hash] A customizable set of options.
-      # @return [Hashie::Rash] The requested list of collections.
+      # @return [Hashie::Mash] The requested list of collections.
       # @see http://dev.evrythng.net/doc/get/collections
       # @example Return the list of collections
       #   Evrythng.collections
@@ -25,7 +25,7 @@ module Evrythng
       # @param name [String] The name of collection.
       # @param description [String] The description of collection.
       # @param options [Hash] A customizable set of options.
-      # @return [Hashie::Rash] The created collection.
+      # @return [Hashie::Mash] The created collection.
       # @see http://dev.evrythng.net/doc/post/collections
       # @example Create the authenticating user's collection
       #   Evrythng.collection_create("This is a new collection!", "Here comes the description.")

data/lib/evrythng/client/thngs.rb

@@ -8,7 +8,7 @@ module Evrythng
       # @authenticated true
       # @rate_limited true
       # @param options [Hash] A customizable set of options.
-      # @return [Hashie::Rash] The requested list of thngs.
+      # @return [Hashie::Mash] The requested list of thngs.
       # @see http://developer.evrythng.net/thngs
       # @example Return the list of thngs
       #   Evrythng.thngs
@@ -25,7 +25,7 @@ module Evrythng
       # @param identifier [String] The identifier of thng.
       # @param description [String] The description of thng.
       # @param options [Hash] A customizable set of options.
-      # @return [Hashie::Rash] The created thng.
+      # @return [Hashie::Mash] The created thng.
       # @see http://developer.evrythng.net/thngs
       # @example Create the authenticating user's thng
       #   Evrythng.thng_create("my.test.thng", "Here comes the description.")

data/lib/evrythng/configuration.rb

@@ -21,11 +21,9 @@ module Evrythng
       :user_agent].freeze
 
     # An array of valid request/response formats
-    #
-    # @note Not all methods support the XML format.
     VALID_FORMATS = [
-      :json,
-      :xml].freeze
+      'vnd.evrythng-v1+json'
+    ].freeze
 
     # The adapter that will be used to connect if none is set
     #
@@ -45,12 +43,10 @@ module Evrythng
     DEFAULT_PASSWORD = nil
 
     # The endpoint that will be used to connect if none is set
-    DEFAULT_ENDPOINT = 'http://api.evrythng.net'.freeze
+    DEFAULT_ENDPOINT = 'http://evrythng.net'.freeze
 
     # The response format appended to the path and sent in the 'Accept' header if none is set
-    #
-    # @note JSON is preferred over XML because it is more concise and faster to parse.
-    DEFAULT_FORMAT = :json
+    DEFAULT_FORMAT = 'vnd.evrythng-v1+json'.freeze
 
     # By default, don't set a user oauth token
     DEFAULT_OAUTH_TOKEN = nil

data/lib/evrythng/connection.rb

@@ -11,9 +11,12 @@ module Evrythng
   module Connection
     private
 
-    def connection(raw=false)
+    def connection(format=format)
       options = {
-        :headers => {'Accept' => "application/vnd.evrythng-v1+json", 'User-Agent' => user_agent},
+        :headers => {
+          :accept => "application/#{format}",
+          :user_agent => user_agent
+        },
         :proxy => proxy,
         :ssl => {:verify => false},
         :url => api_endpoint,
@@ -21,20 +24,14 @@ module Evrythng
 
       Faraday.new(options) do |builder|
         builder.use Faraday::Request::MultipartWithFile
-        builder.use Faraday::Request::Multipart
+        # builder.use Faraday::Request::EvrythngOAuth, authentication if authenticated?
         builder.use Faraday::Request::BasicAuthentication, username, password
+        builder.use Faraday::Request::Multipart
         builder.use Faraday::Request::UrlEncoded
         builder.use Faraday::Request::Gateway, gateway if gateway
         builder.use Faraday::Response::RaiseHttp4xx
-        builder.use Faraday::Response::Rashify unless raw
-        unless raw
-          case format.to_s.downcase
-          when 'json'
-            builder.use Faraday::Response::ParseJson
-          when 'xml'
-            builder.use Faraday::Response::ParseXml
-          end
-        end
+        builder.use Faraday::Response::Mashify
+        builder.use Faraday::Response::ParseJson
         builder.use Faraday::Response::RaiseHttp5xx
         builder.adapter(adapter)
       end

data/lib/evrythng/request.rb

@@ -2,31 +2,31 @@ module Evrythng
   # Defines HTTP request methods
   module Request
     # Perform an HTTP GET request
-    def get(path, options={}, raw=false)
-      request(:get, path, options, raw)
+    def get(path, options={}, format=format)
+      request(:get, path, options, format)
     end
 
     # Perform an HTTP POST request
-    def post(path, options={}, raw=false)
-      request(:post, path, options, raw)
+    def post(path, options={}, format=format)
+      request(:post, path, options, format)
     end
 
     # Perform an HTTP PUT request
-    def put(path, options={}, raw=false)
-      request(:put, path, options, raw)
+    def put(path, options={}, format=format)
+      request(:put, path, options, format)
     end
 
     # Perform an HTTP DELETE request
-    def delete(path, options={}, raw=false)
-      request(:delete, path, options, raw)
+    def delete(path, options={}, format=format)
+      request(:delete, path, options, format)
     end
 
     private
 
     # Perform an HTTP request
-    def request(method, path, options, raw=false)
-      response = connection(raw).send(method) do |request|
-        case method
+    def request(method, path, options, format)
+      response = connection(format).send(method) do |request|
+        case method.to_sym
         when :get, :delete
           request.url(path, options)
         when :post, :put
@@ -34,7 +34,7 @@ module Evrythng
           request.body = options unless options.empty?
         end
       end
-      raw ? response : response.body
+      'raw' == format.to_s.downcase ? response : response.body
     end
   end
 end

data/lib/evrythng/search.rb

@@ -0,0 +1,173 @@
+require 'cgi'
+
+module Evrythng
+  # Wrapper for the Evrythng Search API
+  class Search < API
+    include Enumerable
+
+    # @private
+    attr_reader :query
+
+    # Creates a new search
+    #
+    # @example Initialize an Evrythng search
+    #   search = Evrythng::Search.new
+    def initialize(*)
+      clear
+      super
+    end
+
+    # Clears all query filters and cached results
+    #
+    # @return [Evrythng::Search] self
+    # @example Clear a search for "evrythng"
+    #   search = Evrythng::Search.new
+    #   search.containing("bike").fetch
+    #   search.clear
+    #   search.fetch_next_page #=> 403 Forbidden: You must enter a query.
+    def clear
+      @cache = nil
+      @query = {}
+      @query[:q] = []
+      self
+    end
+
+    # @group Generic filters
+
+    # Search query
+    #
+    # @param query [String] The search query.
+    # @return [Evrythng::Search] self
+    # @example Return an array of thngs containing "bike"
+    #   Evrythng::Search.new.containing("bike").fetch
+    def containing(query)
+      @query[:q] << query
+      self
+    end
+
+    # Negative search query
+    #
+    # @param query [String] The negative search query.
+    # @return [Evrythng::Search] self
+    # @example Return an array of thngs containing "bike" but not "mountain"
+    #   Evrythng::Search.new.containing("bike").not_containing("mountain").fetch
+    def not_containing(query)
+      @query[:q] << "-#{query}"
+      self
+    end
+
+    # Only include thngs from users in a given radius of a given location
+    #
+    # @param lat [Float] A latitude.
+    # @param long [Float] A longitude.
+    # @param radius [String] A search radius, specified in either 'mi' (miles) or 'km' (kilometers).
+    # @return [Evrythng::Search] self
+    # @example Return an array of thngs within a 1-kilometer radius of Barcelona
+    #   Evrythng::Search.new.containing("bike").geocode(41.38, 2.18, "1km").fetch
+    def geocode(lat, long, radius)
+      @query[:geocode] = [lat, long, radius].join(",")
+      self
+    end
+
+    # @group User filters
+
+    # Only include thngs owned by a given user, specified by screen_name
+    #
+    # @param screen_name [String] A Evrythng user name.
+    # @return [Evrythng::Search] self
+    # @example Return an array of thngs containing "bike" from "mike"
+    #   Evrythng::Search.new.containing("bike").from("mike").fetch
+    def from(screen_name)
+      @query[:q] << "from:#{screen_name}"
+      self
+    end
+
+    # Exclude thngs from a given user, specified by screen_name
+    #
+    # @param screen_name [String] A Evrythng user name.
+    # @return [Evrythng::Search] self
+    # @example Return an array of thngs containing "bike" from everyone except "mike"
+    #   Evrythng::Search.new.containing("bike").not_from("mike").fetch
+    def not_from(screen_name)
+      @query[:q] << "-from:#{screen_name}"
+      self
+    end
+
+    # @group Paging
+
+    # Specify the number of thngs to return per page
+    #
+    # @param number [Integer] The number of thngs to return per page, up to a max of 100.
+    # @return [Evrythng::Search] self
+    # @example Return an array of 100 thngs containing "bike"
+    #   Evrythng::Search.new.containing("bike").per_page(100).fetch
+    def per_page(number=15)
+      @query[:per_page] = number
+      self
+    end
+
+    # Specify the page number to return, up to a maximum of roughly 500 results
+    #
+    # @param number [Integer] The page number (starting at 1) to return, up to a max of roughly 500 results (based on {Evrythng::Client::Search#per_page} * {Evrythng::Client::Search#page}).
+    # @return [Evrythng::Search] self
+    # @example Return the second page of thngs containing "bike"
+    #   Evrythng::Search.new.containing("bike").page(2).fetch
+    def page(number)
+      @query[:page] = number
+      self
+    end
+
+    # Indicates if there are additional results to be fetched
+    #
+    # @return [Boolean]
+    # @example
+    #   search = Evrythng::Search.new.containing("bike").fetch
+    #   search.next_page? #=> true
+    def next_page?
+      fetch if @cache.nil?
+      !!@cache["next_page"]
+    end
+
+    # @group Fetching
+
+    # Fetch the next page of results of the query
+    #
+    # @return [Array] Thngs that match specified query.
+    # @example Return the first two pages of results
+    #   search = Evrythng::Search.new.containing("bike").fetch
+    #   search.fetch_next_page
+    def fetch_next_page
+      if next_page?
+        @cache = get("search", CGI.parse(@cache["next_page"][1..-1]), :json)
+        @cache.results
+      end
+    end
+
+    # Fetch the results of the query
+    #
+    # @param force [Boolean] Ignore the cache and hit the API again.
+    # @return [Array] Thngs that match specified query.
+    # @example Return an array of thngs containing "bike"
+    #   search = Evrythng::Search.new.containing("bike").fetch
+    def fetch(force=false)
+      if @cache.nil? || force
+        options = query.dup
+        options[:q] = options[:q].join(" ")
+        @cache = get("search", options, :json)
+      end
+      @cache.results
+    end
+
+    # Calls block once for each element in self, passing that element as a parameter
+    #
+    # @yieldparam [Hashie::Mash] result Thngs that matches specified query.
+    # @return [Array] Thngs that match specified query.
+    # @example
+    #   Evrythng::Search.new.containing('cafe del mar').each do |result|
+    #     puts "#{result.identifier} by #{result.owner}"
+    #   end
+    def each
+      fetch.each{|result| yield result}
+    end
+  end
+end

data/lib/evrythng/version.rb

@@ -1,4 +1,4 @@
 module Evrythng
   # The version of the gem
-  VERSION = '0.0.3'.freeze unless defined?(::Evrythng::VERSION)
+  VERSION = '0.0.5'.freeze unless defined?(::Evrythng::VERSION)
 end

data/lib/evrythng.rb

@@ -1,25 +1,27 @@
-require 'evrythng/error'
-require 'evrythng/configuration'
 require 'evrythng/api'
 require 'evrythng/client'
+require 'evrythng/configuration'
+require 'evrythng/error'
+require 'evrythng/search'
 
 module Evrythng
   extend Configuration
+  class << self
+    # Alias for Evrythng::Client.new
+    #
+    # @return [Evrythng::Client]
+    def new(options={})
+      Evrythng::Client.new(options)
+    end
 
-  # Alias for Evrythng::Client.new
-  #
-  # @return [Evrythng::Client]
-  def self.new(options={})
-    Evrythng::Client.new(options)
-  end
-
-  # Delegate to Evrythng::Client
-  def self.method_missing(method, *args, &block)
-    return super unless new.respond_to?(method)
-    new.send(method, *args, &block)
-  end
+    # Delegate to evrythng::Client
+    def method_missing(method, *args, &block)
+      return super unless new.respond_to?(method)
+      new.send(method, *args, &block)
+    end
 
-  def self.respond_to?(method, include_private = false)
-    new.respond_to?(method, include_private) || super(method, include_private)
+    def respond_to?(method, include_private = false)
+      new.respond_to?(method, include_private) || super(method, include_private)
+    end
   end
 end

data/lib/faraday/request/multipart_with_file.rb

@@ -20,10 +20,14 @@ module Faraday
 
     def mime_type(file)
       case file.path
-        when /\.jpe?g/i then 'image/jpeg'
-        when /\.gif$/i then 'image/gif'
-        when /\.png$/i then 'image/png'
-        else 'application/octet-stream'
+      when /\.jpe?g/i
+        'image/jpeg'
+      when /\.gif$/i
+        'image/gif'
+      when /\.png$/i
+        'image/png'
+      else
+        'application/octet-stream'
       end
     end
   end

data/lib/faraday/response/raise_http_5xx.rb

@@ -11,7 +11,7 @@ module Faraday
       when 502
         raise Evrythng::BadGateway.new(error_message(env, "Evrythng is down or being upgraded."), env[:response_headers])
       when 503
-        raise Evrythng::ServiceUnavailable.new(error_message(env, "(__-){ Evrythng is over capacity."), env[:response_headers])
+        raise Evrythng::ServiceUnavailable.new(error_message(env, "Evrythng is over capacity."), env[:response_headers])
       end
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: evrythng
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-07-18 00:00:00.000000000Z
+date: 2011-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: yard
-  requirement: &70139585247600 !ruby/object:Gem::Requirement
+  name: maruku
+  requirement: &70184618669300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,76 +21,131 @@ dependencies:
         version: '0.6'
   type: :development
   prerelease: false
-  version_requirements: *70139585247600
+  version_requirements: *70184618669300
 - !ruby/object:Gem::Dependency
-  name: hashie
-  requirement: &70139585247000 !ruby/object:Gem::Requirement
+  name: nokogiri
+  requirement: &70184618668780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.0.0
-  type: :runtime
+        version: '1.4'
+  type: :development
   prerelease: false
-  version_requirements: *70139585247000
+  version_requirements: *70184618668780
 - !ruby/object:Gem::Dependency
-  name: faraday
-  requirement: &70139585246440 !ruby/object:Gem::Requirement
+  name: rake
+  requirement: &70184618668220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.6.1
-  type: :runtime
+        version: '0.9'
+  type: :development
   prerelease: false
-  version_requirements: *70139585246440
+  version_requirements: *70184618668220
 - !ruby/object:Gem::Dependency
-  name: faraday_middleware
-  requirement: &70139585245920 !ruby/object:Gem::Requirement
+  name: rspec
+  requirement: &70184618667680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: *70184618667680
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &70184618667060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: *70184618667060
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: &70184618666540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: *70184618666540
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &70184618665940 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: *70184618665940
+- !ruby/object:Gem::Dependency
+  name: ZenTest
+  requirement: &70184618665460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.5'
+  type: :development
+  prerelease: false
+  version_requirements: *70184618665460
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: &70184618665000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.6.3
+        version: 1.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *70139585245920
+  version_requirements: *70184618665000
 - !ruby/object:Gem::Dependency
-  name: multi_json
-  requirement: &70139585245460 !ruby/object:Gem::Requirement
+  name: faraday
+  requirement: &70184618664480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 0.7.4
   type: :runtime
   prerelease: false
-  version_requirements: *70139585245460
+  version_requirements: *70184618664480
 - !ruby/object:Gem::Dependency
-  name: multi_xml
-  requirement: &70139585244920 !ruby/object:Gem::Requirement
+  name: faraday_middleware
+  requirement: &70184618664000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.7.0
   type: :runtime
   prerelease: false
-  version_requirements: *70139585244920
+  version_requirements: *70184618664000
 - !ruby/object:Gem::Dependency
-  name: rash
-  requirement: &70139585244420 !ruby/object:Gem::Requirement
+  name: multi_json
+  requirement: &70184618663520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 1.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70139585244420
+  version_requirements: *70184618663520
 - !ruby/object:Gem::Dependency
   name: simple_oauth
-  requirement: &70139585243900 !ruby/object:Gem::Requirement
+  requirement: &70184618662980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -98,7 +153,7 @@ dependencies:
         version: 0.1.5
   type: :runtime
   prerelease: false
-  version_requirements: *70139585243900
+  version_requirements: *70184618662980
 description: A Ruby wrapper for Evrythng API. Just proof of concept, do not consider
   this as a solid library.
 email: graf.otodrakula@gmail.com
@@ -106,6 +161,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
+- Gemfile
 - README.md
 - Rakefile
 - evrythng.gemspec
@@ -119,12 +176,12 @@ files:
 - lib/evrythng/connection.rb
 - lib/evrythng/error.rb
 - lib/evrythng/request.rb
+- lib/evrythng/search.rb
 - lib/evrythng/version.rb
 - lib/faraday/request/basic_authentication.rb
 - lib/faraday/request/evrythng_oauth.rb
 - lib/faraday/request/gateway.rb
 - lib/faraday/request/multipart_with_file.rb
-- lib/faraday/request/oauth.rb
 - lib/faraday/response/raise_http_4xx.rb
 - lib/faraday/response/raise_http_5xx.rb
 homepage: http://github.com/bai/evrythng-ruby
@@ -147,7 +204,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.5
+rubygems_version: 1.8.7
 signing_key: 
 specification_version: 3
 summary: A Ruby wrapper for Evrythng API

data/lib/faraday/request/oauth.rb

@@ -1,24 +0,0 @@
-require 'faraday'
-
-module Faraday
-  class Request::OAuth < Faraday::Middleware
-    dependency 'simple_oauth'
-
-    def call(env)
-      params = env[:body] || {}
-      signature_params = params
-
-      params.map{ |k,v| signature_params = {} if v.respond_to?(:content_type) }
-
-      header = SimpleOAuth::Header.new(env[:method], env[:url], signature_params, @options)
-
-      env[:request_headers]['Authorization'] = header.to_s
-
-      @app.call(env)
-    end
-
-    def initialize(app, options)
-      @app, @options = app, options
-    end
-  end
-end