i_heart_quotes 0.1.0 → 0.2.0

data/README.md

@@ -8,6 +8,10 @@ This is a ruby client to interact with the [I <3 Quotes](http://iheartquotes.com
 
 (Working on Ruby 1.9.X - Let me know if you need the 1.8.X version)
 
+## Full Documentation
+
+http://rdoc.info/gems/i_heart_quotes/frames
+
 ## Authors
 
 Roberto Decurnex (nex.development@gmail.com)
@@ -42,4 +46,24 @@ You can also clone the project with Git by running:
     fortune.tags #=> ["hitchhiker"]
 
     fortune.link #=> "http://iheartquotes.com/fortune/show/7934"
+
+### Using filters
+
+    require 'i_heart_quotes'
  
+    # Returns a quote from the hitchhiker that has a single line.
+    IHeartQuotes::Client.where(:source => "hitchhiker", :max_lines => 1).random
+
+    # Returns a quote from the either hitchhiker or cryptonomicon that has at most 2 lines.
+    # Note that you can chain as many where s as you want.
+    IHeartQuotes::Client.where(:source => "hitchhiker+cryptonomicon").where(:max_lines => 2).random
+
+## Supported Filters
+
+* **:source** ("+" separated list of desired sources. Available sources at http://iheartquotes.com/api)
+* **:max_lines** (maximum number of lines in the quote)
+* **:min_lines** (minumum number of lines in the quote)
+* **:max_characters** (maximum number of characters in the quote)
+* **:min_characters** (minimum number of characters in the quote)
+
+

data/i_heart_quotes.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name = 'i_heart_quotes'
-  s.version = '0.1.0'
-  s.date = '2012-03-06'
+  s.version = '0.2.0'
+  s.date = '2012-03-14'
   s.summary = 'I <3 Quotes Client'
   s.authors = ['Roberto Decurnex']
   s.email = 'nex.development@gmail.com'

data/lib/i_heart_quotes/client.rb

@@ -2,17 +2,58 @@ module IHeartQuotes
 
   # I <3 Quotes Client
   class Client
-    
+
     # Random call API path
-    RANDOM_PATH  = '/api/v1/random?format=json'
+    RANDOM_PATH  = '/api/v1/random'
 
     include HTTParty
 
     self.base_uri 'http://iheartquotes.com'
     self.format :json
 
+    def initialize
+      @options = {:format => 'json'}
+    end
+
+    # Instanciates an IHeartQuotes::Client object and
+    # return a randome IHeartQuotes::Fortune
+    #
+    # @return <IHeartQuotes::Fortune>
     def self.random
-      return Fortune.new(self.get(RANDOM_PATH))
+      Client.new.random
+    end
+   
+    # Instantiates an IHeartQuotes::Client object and 
+    # set the given options via the where method
+    #
+    # @return <IHeartQuotes::Client>
+    def self.where(opts)
+      Client.new.where(opts)
+    end
+
+    # Gets a random fortune
+    #
+    # @return <IHeartQuotes::Fortune>
+    def random
+      return Fortune.new(self.class.get(RANDOM_PATH, :query => @options))
+    end
+
+
+    # Sets filters for the fortunes search
+    #
+    # Filters Supported:
+    # * :source ("+" separated list of desired sources - available sources at http://iheartquotes.com/api)
+    # * :max_lines (maximum number of lines in the quote)
+    # * :min_lines (minumum number of lines in the quote)
+    # * :max_characters (maximum number of characters in the quote)
+    # * :min_characters (minimum number of characters in the quote)
+    #
+    # @param {Symbol => String,Number} opts filters to be set
+    # @return <IHeartQuotes::Client>
+    def where(opts)
+      opts.delete(:format)
+      @options.merge!(opts)
+      self
     end
 
   end

data/lib/i_heart_quotes.rb

@@ -1,5 +1,7 @@
 require 'httparty'
 
+require_relative 'fortune'
+
 require_relative 'i_heart_quotes/fortune'
 require_relative 'i_heart_quotes/client'
 

data/spec/i_heart_quotes/client_spec.rb

@@ -1,9 +1,27 @@
 require_relative '../spec_helper'
 
 describe IHeartQuotes::Client do
-
+ 
   it 'should return a random Fortune when requested' do
     IHeartQuotes::Client.random.should be_an_instance_of IHeartQuotes::Fortune
+    IHeartQuotes::Client.new.random.should be_an_instance_of IHeartQuotes::Fortune
+  end
+
+  describe 'filtered by source' do
+
+    it 'should return only quotes from the target source' do
+      IHeartQuotes::Client.where({:source => 'hitchhiker'}).random.source.should == 'hitchhiker'
+      IHeartQuotes::Client.where({:source => 'cryptonomicon'}).random.should be_an_instance_of IHeartQuotes::Fortune
+    end
+
+  end
+
+  describe 'with valid filters' do
+
+    it 'should return a valid quote' do
+      IHeartQuotes::Client.where({:source => 'hitchhiker+cryptonomicon'}).where(:max_lines => 1).random.should be_an_instance_of IHeartQuotes::Fortune
+    end
+
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: i_heart_quotes
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-06 00:00:00.000000000Z
+date: 2012-03-14 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &22770300 !ruby/object:Gem::Requirement
+  requirement: &23137980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *22770300
+  version_requirements: *23137980
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &22769860 !ruby/object:Gem::Requirement
+  requirement: &23137540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *22769860
+  version_requirements: *23137540
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &22805000 !ruby/object:Gem::Requirement
+  requirement: &23137120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *22805000
+  version_requirements: *23137120
 description: 
 email: nex.development@gmail.com
 executables: []
@@ -90,3 +90,4 @@ signing_key:
 specification_version: 3
 summary: I <3 Quotes Client
 test_files: []
+has_rdoc: