rippy_rules 0.0.1 → 0.0.2

data/README.md

@@ -1,3 +1,5 @@
+<a href="https://codeclimate.com/github/MrCheese/rippy_rules"><img src="https://codeclimate.com/badge.png" /></a>
+
 # RippyRules
 
 A Ruby wrapper for the What.cd JSON API
@@ -36,6 +38,13 @@ client = RippyRules::Client.new(your_whatcd_username, your_whatcd_password)
 results = client.browse({searchstr: 'Bruce Springsteen'})
 ```
 
+There is also a search method that can be used for simpler searches where you only care about getting results.
+It is equivalent to calling browse with a searchstr
+```ruby
+client = RippyRules::Client.new(your_whatcd_username, your_whatcd_password)
+results = client.search 'Bruce Springsteen'
+```
+
 ## Contributing
 
 To contribute to RippyRules, you must have a What.cd account. I do not have one and I do not know how to acquire one.

data/lib/rippy_rules/rippy_rules.rb

@@ -11,22 +11,32 @@ module RippyRules
       authenticate
     end
 
+    def search(str)
+      browse({searchstr: str})
+    end
+
     def method_missing(method, *params)
-      raise APIError unless params.first.is_a?(Hash)
-      perform_request(method.to_s,params.first)
+      first_param = params.first
+      raise APIError unless first_param.is_a?(Hash)
+      perform_request(method.to_s,first_param)
     end
 
     def perform_request(method, query={})
-      self.class.get("/ajax.php?action=#{method}", :query => query)
+      self.class.get("/ajax.php", :query => query.merge({action: method}))
     end
 
     private
 
     def authenticate
-      body = {:username => @username, :password => @password, :keeplogged => 1}
+      body = {username: @username, password: @password, keeplogged: 1}
+      response = login(body)
+      cookies(response.headers['set-cookie'])
+    end
+
+    def login(body)
       response = self.class.post('/login.php', :body => body, :follow_redirects => false)
       raise AuthenticationError if response.headers['set-cookie'].nil?
-      cookies(response.headers['set-cookie'])
+      response
     end
 
     def cookies(cookie)
@@ -34,6 +44,7 @@ module RippyRules
       cookie_jar.add_cookies cookie
       self.class.cookies cookie_jar
     end
+
   end
   class AuthenticationError < StandardError; end
   class APIError < StandardError; end

data/lib/rippy_rules/version.rb

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

data/spec/lib/rippy_rules/rippy_rules_spec.rb

@@ -3,34 +3,39 @@ require 'spec_helper'
 describe RippyRules::Client do
   use_vcr_cassette :record => :new_episodes, :match_requests_on => [:body, :uri]
 
-  it "includes HTTParty" do
-    rippy_rules = RippyRules::Client.new(WHATCD_USERNAME,WHATCD_PASSWORD)
-    rippy_rules.kind_of?(HTTParty).should be_true
-  end
+  subject{RippyRules::Client.new(WHATCD_USERNAME,WHATCD_PASSWORD)}
+
+  it {subject.kind_of?(HTTParty).should be_true}
 
   describe "#initialize" do
     context "when given valid authentication information" do
       it "authenticates the user" do
-        rippy_rules = RippyRules::Client.new(WHATCD_USERNAME, WHATCD_PASSWORD)
-        rippy_rules.class.cookies[:session].nil?.should == false
+        subject.class.cookies[:session].nil?.should be_false
       end
     end
 
     context "when the authentication fails" do
       it "throws an AuthenticationError" do
-        expect{rippy_rules = RippyRules::Client.new('foo', 'bar')}.to raise_error(RippyRules::AuthenticationError)
+        expect{RippyRules::Client.new('foo', 'bar')}.to raise_error(RippyRules::AuthenticationError)
       end
     end
   end
 
+  describe "#search" do
+    it "calls browse with the given string as 'searchstr'" do
+      str = 'bruce springsteen'
+      subject.expects(:browse).with({searchstr: str})
+      subject.search str
+    end
+  end
+
   describe "#method_missing?" do
-    let(:rippy_rules){RippyRules::Client.new(WHATCD_USERNAME, WHATCD_PASSWORD)}
     context "when given an action and a hash" do
       it "performs a request with the method name as the request type" do
         method = 'top10'
-        params = {:type => :users}
-        results = rippy_rules.send(method.to_sym, params)
-        results['response'].first['results'].size == 10
+        params = {type: :users}
+        results = subject.send(method.to_sym, params)
+        results['response'].first['results'].size.should eq(10)
       end
     end
 
@@ -38,18 +43,18 @@ describe RippyRules::Client do
       it "throws an APIError" do
         method = 'eatmyshorts'
         param = 'foo'
-        expect{rippy_rules.send(method.to_sym,param)}.to raise_error(RippyRules::APIError)
+        expect{subject.send(method.to_sym,param)}.to raise_error(RippyRules::APIError)
       end
     end
   end
 
   describe "#perform_request" do
-    let(:rippy_rules){RippyRules::Client.new(WHATCD_USERNAME, WHATCD_PASSWORD)}
     it "performs a GET request with the correct parameters" do
       method = 'top10'
-      query = {:limit => 10, :type => :torrents}
-      rippy_rules.class.expects(:get).with("/ajax.php?action=top10", :query => query)
-      rippy_rules.send(method.to_sym, query)
+      query = {limit: 10, type: :torrents}
+      query_with_method = query.merge({action: method})
+      subject.class.expects(:get).with("/ajax.php", query: query_with_method)
+      subject.send(method.to_sym, query)
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rippy_rules
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-09 00:00:00.000000000 Z
+date: 2012-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec