assistly 0.1.2 → 0.1.3

data/lib/assistly/api.rb

@@ -11,10 +11,15 @@ module Assistly
     # Creates a new API
     def initialize(options={})
       options = Assistly.options.merge(options)
+      
       Configuration::VALID_OPTIONS_KEYS.each do |key|
         send("#{key}=", options[key])
       end
     end
+    
+    def endpoint
+      "https://#{self.subdomain}.assistly.com/api/#{self.version}/"
+    end
 
     include Connection
     include Request

data/lib/assistly/configuration.rb

@@ -9,7 +9,6 @@ module Assistly
       :adapter,
       :consumer_key,
       :consumer_secret,
-      :endpoint,
       :format,
       :oauth_token,
       :oauth_token_secret,
@@ -57,15 +56,7 @@ module Assistly
 
     # The user agent that will be sent to the API endpoint if none is set
     DEFAULT_VERSION = "v1".freeze
-    
-    # The endpoint that will be used to connect if none is set
-    #
-    # @note This is configurable in case you want to use HTTP instead of HTTPS, specify a different API version, or use a Twitter-compatible endpoint.
-    # @see http://status.net/wiki/Twitter-compatible_API
-    # @see http://en.blog.wordpress.com/2009/12/12/twitter-api/
-    # @see http://staff.tumblr.com/post/287703110/api
-    # @see http://developer.typepad.com/typepad-twitter-api/twitter-api.html
-    # DEFAULT_ENDPOINT = "https://#{self.subdomain}.assistly.com/api/#{Assistly.version}/"
+
 
     # @private
     attr_accessor *VALID_OPTIONS_KEYS
@@ -90,7 +81,6 @@ module Assistly
       self.adapter            = DEFAULT_ADAPTER
       self.consumer_key       = DEFAULT_CONSUMER_KEY
       self.consumer_secret    = DEFAULT_CONSUMER_SECRET
-      self.endpoint           = "https://#{Assistly.subdomain}.assistly.com/api/#{Assistly.version}/"
       self.format             = DEFAULT_FORMAT
       self.oauth_token        = DEFAULT_OAUTH_TOKEN
       self.oauth_token_secret = DEFAULT_OAUTH_TOKEN_SECRET

data/lib/assistly/version.rb

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

data/spec/assistly/api_spec.rb

@@ -35,7 +35,6 @@ describe Assistly::API do
           :oauth_token => 'OT',
           :oauth_token_secret => 'OS',
           :adapter => :typhoeus,
-          :endpoint => 'http://tumblr.com/',
           :format => :xml,
           :proxy => 'http://erik:sekret@proxy.example.com:8080',
           :subdomain => 'zencoder',

data/spec/assistly_spec.rb

@@ -44,19 +44,6 @@ describe Assistly do
       Assistly.adapter.should == :typhoeus
     end
   end
-
-  # describe ".endpoint" do
-  #   it "should return the default endpoint" do
-  #     Assistly.endpoint.should == Assistly::Configuration::DEFAULT_ENDPOINT
-  #   end
-  # end
-
-  describe ".endpoint=" do
-    it "should set the endpoint" do
-      Assistly.endpoint = 'http://tumblr.com/'
-      Assistly.endpoint.should == 'http://tumblr.com/'
-    end
-  end
   
   describe ".subdomain=" do
     before do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: assistly
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 29
   prerelease: 
   segments: 
   - 0
   - 1
-  - 2
-  version: 0.1.2
+  - 3
+  version: 0.1.3
 platform: ruby
 authors: 
 - Chris Warren
@@ -298,7 +298,6 @@ files:
 - lib/assistly/connection.rb
 - lib/assistly/error.rb
 - lib/assistly/request.rb
-- lib/assistly/search.rb
 - lib/assistly/version.rb
 - lib/faraday/request/multipart_with_file.rb
 - lib/faraday/response/raise_http_4xx.rb

data/lib/assistly/search.rb

@@ -1,473 +0,0 @@
-require 'cgi'
-
-module Twitter
-  # Wrapper for the Twitter Search API
-  #
-  # @note As of April 1st 2010, the Search API provides an option to retrieve
-  #   "popular tweets" in addition to real-time search results. In an upcoming release,
-  #   this will become the default and clients that don't want to receive popular tweets
-  #   in their search results will have to explicitly opt-out. See {Twitter::Search#result_type}
-  #   for more information.
-  # @note The user ids in the Search API are different from those in the REST API
-  #   ({http://dev.twitter.com/pages/api_overview about the two APIs}). This defect is
-  #   being tracked by {http://code.google.com/p/twitter-api/issues/detail?id=214 Issue 214}.
-  #   This means that the to_user_id and from_user_id field vary from the actualy user id on
-  #   Twitter.com. Applications will have to perform a screen name-based lookup with
-  #   {Twitter::Client::User#user} to get the correct user id if necessary.
-  # @see http://dev.twitter.com/doc/get/search Twitter Search API Documentation
-  class Search < API
-    include Enumerable
-
-    # @private
-    attr_reader :query
-
-    # Creates a new search
-    #
-    # @example Initialize a Twitter search
-    #   search = Twitter::Search.new
-    def initialize(*)
-      clear
-      super
-    end
-
-    alias :api_endpoint :search_endpoint
-
-    # Clears all query filters and cached results
-    #
-    # @return [Twitter::Search] self
-    # @example Clear a search for "twitter"
-    #   search = Twitter::Search.new
-    #   search.containing("twitter").fetch
-    #   search.clear
-    #   search.fetch_next_page #=> 403 Forbidden: You must enter a query.
-    def clear
-      @cache = nil
-      @query = {}
-      @query[:q] = []
-      @query[:tude] = []
-      self
-    end
-
-    # @group Generic filters
-
-    # Search query
-    #
-    # @param query [String] The search query.
-    # @return [Twitter::Search] self
-    # @example Return an array of tweets containing "twitter"
-    #   Twitter::Search.new.containing("twitter").fetch
-    #   Twitter::Search.new.contains("twitter").fetch   # Shortcut for the above
-    #   Twitter::Search.new.q("twitter").fetch          # Even shorter-cut
-    def containing(query)
-      @query[:q] << query
-      self
-    end
-    alias :contains :containing
-    alias :q :containing
-
-    # Negative search query
-    #
-    # @param query [String] The negative search query.
-    # @return [Twitter::Search] self
-    # @example Return an array of tweets containing "beer" but not "root"
-    #   Twitter::Search.new.containing("beer").not_containing("root").fetch
-    #   Twitter::Search.new.containing("beer").does_not_contain("root").fetch # Same as above
-    #   Twitter::Search.new.containing("beer").excluding("root").fetch        # Shortcut for the above
-    #   Twitter::Search.new.contains("beer").excludes("root").fetch           # Even shorter
-    #   Twitter::Search.new.q("beer").exclude("root").fetch                   # Shorter still
-    def not_containing(query)
-      @query[:q] << "-#{query}"
-      self
-    end
-    alias :does_not_contain :not_containing
-    alias :excluding :not_containing
-    alias :excludes :not_containing
-    alias :exclude :not_containing
-
-    # Search for a specific phrase instead of a group of words
-    #
-    # @param phrase [String] The search phrase.
-    # @return [Twitter::Search] self
-    # @example Return an array of tweets containing the phrase "happy hour"
-    #   Twitter::Search.new.phrase("happy hour").fetch
-    def phrase(phrase)
-      @query[:phrase] = phrase
-      self
-    end
-
-    # Only include tweets that contain URLs
-    #
-    # @param filter [String] A type of search filter. Only 'links' is currently effective.
-    # @return [Twitter::Search] self
-    # @example Return an array of tweets containing "twitter" and URLs
-    #   Twitter::Search.new.containing("twitter").filter.fetch
-    def filter(filter='links')
-      @query[:q] << "filter:#{filter}"
-      self
-    end
-
-    # Only include tweets from after a given date
-    #
-    # @param date [String] A date in the format YYYY-MM-DD.
-    # @return [Twitter::Search] self
-    # @example Return an array of tweets containing "twitter" since October 1, 2010
-    #   Twitter::Search.new.containing("twitter").since_date("2010-10-01").fetch
-    def since_date(date)
-      @query[:since] = date
-      self
-    end
-    alias :since :since_date
-
-    # Only include tweets from before a given date
-    #
-    # @param date [String] A date in the format YYYY-MM-DD.
-    # @return [Twitter::Search] self
-    # @example Return an array of tweets containing "twitter" up until October 1, 2010
-    #   Twitter::Search.new.containing("twitter").since_date("2010-10-01").fetch
-    def until_date(date)
-      @query[:until] = date
-      self
-    end
-    alias :until :until_date
-
-    # Only include tweets with a positive attitude
-    #
-    # @return [Twitter::Search] self
-    # @example Return an array of tweets containing happy emoticons
-    #   Twitter::Search.new.positive.fetch
-    def positive
-      @query[:tude] << ":)"
-      self
-    end
-
-    # Only include tweets with a negative attitude
-    #
-    # @return [Twitter::Search] self
-    # @example Return an array of tweets containing sad emoticons
-    #   Twitter::Search.new.negative.fetch
-    def negative
-      @query[:tude] << ":("
-      self
-    end
-
-    # Only include tweets that are asking a question
-    #
-    # @return [Twitter::Search] self
-    # @example Return an array of tweets containing question marks
-    #   Twitter::Search.new.question.fetch
-    def question
-      @query[:tude] << "?"
-      self
-    end
-
-    # @group Demographic filters
-
-    # Only include tweets in a given language, specified by an ISO 639-1 code
-    #
-    # @param code [String] An ISO 639-1 code.
-    # @return [Twitter::Search] self
-    # @example Return an array of French-language tweets containing "twitter"
-    #   Twitter::Search.new.containing("twitter").language("fr").fetch
-    #   Twitter::Search.new.containing("twitter").lang("fr").fetch     # Shortcut for the above
-    # @see http://en.wikipedia.org/wiki/ISO_639-1
-    def language(code)
-      @query[:lang] = code
-      self
-    end
-    alias :lang :language
-
-    # Specify the locale of the query you are sending
-    #
-    # @param code [String] An ISO 639-1 code (only 'ja' is currently effective).
-    # @return [Twitter::Search] self
-    # @example Return an array of tweets from Japan containing "twitter"
-    #   Twitter::Search.new.containing("twitter").locale("ja").fetch
-    # @see http://en.wikipedia.org/wiki/ISO_639-1
-    def locale(code)
-      @query[:locale] = code
-      self
-    end
-
-    # Only include tweets 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 [Twitter::Search] self
-    # @example Return an array of tweets within a 1-mile radius of Twitter HQ
-    #   Twitter::Search.new.containing("twitter").geocode(37.781157, -122.398720, "1mi").fetch
-    def geocode(lat, long, radius)
-      @query[:geocode] = [lat, long, radius].join(",")
-      self
-    end
-
-    # Only include tweets from users in a given place, specified by a place ID
-    #
-    # @param place_id [String] A place ID.
-    # @return [Twitter::Search] self
-    # @example Return an array of tweets from San Francisco
-    #   Twitter::Search.new.place("5a110d312052166f").fetch
-    def place(place_id)
-      @query[:q] << "place:#{place_id}"
-      self
-    end
-
-    # Only include tweets from users near a given location
-    #
-    # @param location [String] A location name.
-    # @return [Twitter::Search] self
-    # @example Return an array of tweets near San Francisco
-    #   Twitter::Search.new.near("San Francisco").fetch
-    def near(location)
-      @query[:q] << "near:#{location.inspect}"
-      self
-    end
-
-    # @group User filters
-
-    # Only include tweets from a given user, specified by screen_name
-    #
-    # @param screen_name [String] A Twitter user name.
-    # @return [Twitter::Search] self
-    # @example Return an array of tweets containing "twitter" from @sferik
-    #   Twitter::Search.new.containing("twitter").from("sferik").fetch
-    def from(screen_name)
-      @query[:q] << "from:#{screen_name}"
-      self
-    end
-
-    # Exclude tweets from a given user, specified by screen_name
-    #
-    # @param screen_name [String] A Twitter user name.
-    # @return [Twitter::Search] self
-    # @example Return an array of tweets containing "twitter" from everyone except @sferik
-    #   Twitter::Search.new.containing("twitter").not_from("sferik").fetch
-    def not_from(screen_name)
-      @query[:q] << "-from:#{screen_name}"
-      self
-    end
-
-    # Only include tweets to a given user, specified by screen_name
-    #
-    # @param screen_name [String] A Twitter user name.
-    # @return [Twitter::Search] self
-    # @example Return an array of tweets containing "twitter" to @sferik
-    #   Twitter::Search.new.containing("twitter").to("sferik").fetch
-    def to(screen_name)
-      @query[:q] << "to:#{screen_name}"
-      self
-    end
-
-    # Exclude tweets to a given user, specified by screen_name
-    #
-    # @param screen_name [String] A Twitter user name.
-    # @return [Twitter::Search] self
-    # @example Return an array of tweets containing "twitter" to everyone except @sferik
-    #   Twitter::Search.new.containing("twitter").not_to("sferik").fetch
-    def not_to(screen_name)
-      @query[:q] << "-to:#{screen_name}"
-      self
-    end
-
-    # Only include tweets mentioning a given user, specified by screen_name
-    #
-    # @param screen_name [String] A Twitter user name.
-    # @return [Twitter::Search] self
-    # @example Return an array of tweets containing "twitter" and mentioning @sferik
-    #   Twitter::Search.new.containing("twitter").mentioning("sferik").fetch
-    def mentioning(screen_name)
-      @query[:q] << "@#{screen_name.gsub('@', '')}"
-      self
-    end
-    alias :referencing :mentioning
-    alias :mentions :mentioning
-    alias :references :mentioning
-
-    # Exclude tweets mentioning a given user, specified by screen_name
-    #
-    # @param screen_name [String] A Twitter user name.
-    # @return [Twitter::Search] self
-    # @example Return an array of tweets containing "twitter" but not mentioning @sferik
-    #   Twitter::Search.new.containing("twitter").not_mentioning("sferik").fetch
-    def not_mentioning(screen_name)
-      @query[:q] << "-@#{screen_name.gsub('@', '')}"
-      self
-    end
-    alias :not_referencing :not_mentioning
-    alias :does_not_mention :not_mentioning
-    alias :does_not_reference :not_mentioning
-
-    # @group Twitter filters
-
-    # Only include retweets
-    #
-    # @return [Twitter::Search] self
-    # @example Return an array of retweets containing "twitter"
-    #   Twitter::Search.new.containing("twitter").retweets.fetch
-    def retweets
-      @query[:q] << "rt"
-      self
-    end
-
-    # Only include original status updates (i.e., not retweets)
-    #
-    # @return [Twitter::Search] self
-    # @example Return an array of tweets containing "twitter", excluding retweets
-    #   Twitter::Search.new.containing("twitter").no_retweets.fetch
-    def no_retweets
-      @query[:q] << "-rt"
-      self
-    end
-
-    # Only include tweets containing a given hashtag
-    #
-    # @param tag [String] A Twitter hashtag.
-    # @return [Twitter::Search] self
-    # @example Return an array of tweets containing the hashtag #FollowFriday
-    #   Twitter::Search.new.hashtag("FollowFriday").fetch
-    def hashtag(tag)
-      @query[:q] << "\##{tag.gsub('#', '')}"
-      self
-    end
-
-    # Exclude tweets containing a given hashtag
-    #
-    # @param tag [String] A Twitter hashtag.
-    # @return [Twitter::Search] self
-    # @example Return an array of tweets containing the hashtag #FollowFriday but not #FF
-    #   Twitter::Search.new.hashtag("FollowFriday").excluding_hashtag("FF").fetch
-    #   Twitter::Search.new.hashtag("FollowFriday").excludes_hashtag("FF").fetch  # Shortcut for the above
-    #   Twitter::Search.new.hashtag("FollowFriday").exclude_hashtag("FF").fetch   # Even shorter
-    def excluding_hashtag(tag)
-      @query[:q] << "-\##{tag.gsub('#', '')}"
-      self
-    end
-    alias :excludes_hashtag :excluding_hashtag
-    alias :exclude_hashtag :excluding_hashtag
-
-    # Only include tweets with an ID greater than the specified ID
-    #
-    # @param id [Integer] A Twitter status ID.
-    # @return [Twitter::Search] self
-    # @example Return an array of tweets containing "twitter" with an ID greater than 123456789
-    #   Twitter::Search.new.containing("twitter").since_id(123456789).fetch
-    def since_id(id)
-      @query[:since_id] = id
-      self
-    end
-
-    # Only include tweets with an ID less than or equal to the specified ID
-    #
-    # @param id [Integer] A Twitter status ID.
-    # @return [Twitter::Search] self
-    # @example Return an array of tweets containing "twitter" with an ID less than or equal to 123456789
-    #   Twitter::Search.new.containing("twitter").max_id(123456789).fetch
-    #
-    def max_id(id)
-      @query[:max_id] = id
-      self
-    end
-    alias :max :max_id
-
-    # Specify what type of search results you want to receive
-    #
-    # @param result_type [String] The type of results you want to receive ('recent', 'popular', or 'mixed').
-    # @return [Twitter::Search] self
-    # @example Return an array of recent tweets containing "twitter"
-    #   Twitter::Search.new.containing("twitter").result_type("recent").fetch
-    def result_type(result_type="mixed")
-      @query[:result_type] = result_type
-      self
-    end
-
-    # Only include tweets from a given source
-    #
-    # @param source [String] A Twitter source.
-    # @return [Twitter::Search] self
-    # @example Return an array of tweets containing "twitter", posted from Hibari
-    #   Twitter::Search.new.containing("twitter").source("Hibari").fetch
-    def source(source)
-      @query[:q] << "source:#{source}"
-      self
-    end
-
-    # @group Paging
-
-    # Specify the number of tweets to return per page
-    #
-    # @param number [Integer] The number of tweets to return per page, up to a max of 100.
-    # @return [Twitter::Search] self
-    # @example Return an array of 100 tweets containing "twitter"
-    #   Twitter::Search.new.containing("twitter").per_page(100).fetch
-    def per_page(number=15)
-      @query[:rpp] = number
-      self
-    end
-    alias :rpp :per_page
-
-    # Specify the page number to return, up to a maximum of roughly 1500 results
-    #
-    # @param number [Integer] The page number (starting at 1) to return, up to a max of roughly 1500 results (based on {Twitter::Client::Search#per_page} * {Twitter::Client::Search#page}).
-    # @return [Twitter::Search] self
-    # @example Return the second page of tweets containing "twitter"
-    #   Twitter::Search.new.containing("twitter").page(2).fetch
-    def page(number)
-      @query[:page] = number
-      self
-    end
-
-    # Indicates if there are additional results to be fetched
-    #
-    # @return [Boolean]
-    # @example
-    #   search = Twitter::Search.new.containing("twitter").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] Tweets that match specified query.
-    # @example Return the first two pages of results
-    #   search = Twitter::Search.new.containing("twitter").fetch
-    #   search.fetch_next_page
-    def fetch_next_page
-      if next_page?
-        @cache = get("search", CGI.parse(@cache["next_page"][1..-1]))
-        @cache.results
-      end
-    end
-
-    # Fetch the results of the query
-    #
-    # @param force [Boolean] Ignore the cache and hit the API again.
-    # @return [Array] Tweets that match specified query.
-    # @example Return an array of tweets containing "twitter"
-    #   search = Twitter::Search.new.containing("twitter").fetch
-    def fetch(force=false)
-      if @cache.nil? || force
-        options = query.dup
-        options[:q] = options[:q].join(" ")
-        @cache = get("search", options)
-      end
-      @cache.results
-    end
-
-    # Calls block once for each element in self, passing that element as a parameter
-    #
-    # @yieldparam [Hashie::Mash] result Tweet that matches specified query.
-    # @return [Array] Tweets that match specified query.
-    # @example
-    #   Twitter::Search.new.containing('marry me').to('justinbieber').each do |result|
-    #     puts "#{result.from_user}: #{result.text}"
-    #   end
-    def each
-      fetch.each{|result| yield result}
-    end
-
-  end
-end