rippy_rules 0.0.1

data/.gitignore

@@ -0,0 +1,21 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+spec/config.yml
+spec/fixtures/cassette_library/*
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,52 @@
+PATH
+  remote: .
+  specs:
+    rippy_rules (0.0.1)
+      httparty
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.3.2)
+    crack (0.3.1)
+    diff-lcs (1.1.3)
+    guard (1.4.0)
+      listen (>= 0.4.2)
+      thor (>= 0.14.6)
+    guard-rspec (2.0.0)
+      guard (>= 1.1)
+      rspec (~> 2.11)
+    httparty (0.9.0)
+      multi_json (~> 1.0)
+      multi_xml
+    listen (0.5.3)
+    metaclass (0.0.1)
+    mocha (0.12.6)
+      metaclass (~> 0.0.1)
+    multi_json (1.3.6)
+    multi_xml (0.5.1)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.3)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.3)
+    thor (0.16.0)
+    vcr (2.2.5)
+    webmock (1.8.11)
+      addressable (>= 2.2.7)
+      crack (>= 0.1.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  guard
+  guard-rspec
+  mocha
+  rippy_rules!
+  rspec
+  vcr
+  webmock

data/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec',:output => 'specs',:bundler => true,all_on_start: false do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Magnus Skog
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,48 @@
+# RippyRules
+
+A Ruby wrapper for the What.cd JSON API
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rippy_rules'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rippy_rules
+
+## Usage
+
+Initialize a client like so:
+
+```ruby
+client = RippyRules::Client.new(your_whatcd_username, your_whatcd_password)
+```
+You can then run any command in the API by calling it's corresponding method. Each method will return a hash
+
+## API Documentation
+The documentation for the API methods can be found in the What.cd wiki
+
+## Examples
+
+Searching for an artist
+```ruby
+client = RippyRules::Client.new(your_whatcd_username, your_whatcd_password)
+results = client.browse({searchstr: '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.
+If you don't have an account, the specs will not run
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/rippy_rules/rippy_rules.rb

@@ -0,0 +1,40 @@
+module RippyRules
+  class Client
+    include HTTParty
+    base_uri "https://what.cd"
+    maintain_method_across_redirects
+    format :json
+
+    def initialize(username, password)
+      @username = username
+      @password = password
+      authenticate
+    end
+
+    def method_missing(method, *params)
+      raise APIError unless params.first.is_a?(Hash)
+      perform_request(method.to_s,params.first)
+    end
+
+    def perform_request(method, query={})
+      self.class.get("/ajax.php?action=#{method}", :query => query)
+    end
+
+    private
+
+    def authenticate
+      body = {:username => @username, :password => @password, :keeplogged => 1}
+      response = self.class.post('/login.php', :body => body, :follow_redirects => false)
+      raise AuthenticationError if response.headers['set-cookie'].nil?
+      cookies(response.headers['set-cookie'])
+    end
+
+    def cookies(cookie)
+      cookie_jar = HTTParty::CookieHash.new
+      cookie_jar.add_cookies cookie
+      self.class.cookies cookie_jar
+    end
+  end
+  class AuthenticationError < StandardError; end
+  class APIError < StandardError; end
+end

data/lib/rippy_rules/version.rb

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

data/lib/rippy_rules.rb

@@ -0,0 +1,6 @@
+require 'httparty'
+require "rippy_rules/version"
+require "rippy_rules/rippy_rules"
+
+module RippyRules
+end

data/rippy_rules.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rippy_rules/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "rippy_rules"
+  gem.version       = RippyRules::VERSION
+  gem.authors       = ["Magnus Skog"]
+  gem.email         = ["mrcheese0@gmail.com"]
+  gem.description   = "A Ruby library for the What.cd api"
+  gem.summary       = "Ruby What.cd API"
+  gem.homepage      = %q{https://github.com/MrCheese/rippy_rules}
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "rippy_rules"
+  gem.require_paths = ["lib"]
+  gem.version       = RippyRules::VERSION
+
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'mocha'
+  gem.add_development_dependency 'guard'
+  gem.add_development_dependency 'guard-rspec'
+  gem.add_development_dependency 'vcr'
+  gem.add_development_dependency 'webmock'
+
+  gem.add_runtime_dependency 'httparty'
+end

data/spec/config.yml.example

@@ -0,0 +1,2 @@
+whatcd_username: YOUR USERNAME
+whatcd_password: YOUR PASSWORD

data/spec/lib/rippy_rules/rippy_rules_spec.rb

@@ -0,0 +1,56 @@
+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
+
+  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
+      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)
+      end
+    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
+      end
+    end
+
+    context "when the first parameter is not a hash" do
+      it "throws an APIError" do
+        method = 'eatmyshorts'
+        param = 'foo'
+        expect{rippy_rules.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)
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,36 @@
+require 'rspec'
+require 'rippy_rules'
+require 'webmock/rspec'
+require 'vcr'
+require "yaml"
+
+SPEC_DIR = File.dirname(__FILE__)
+lib_path = File.expand_path("#{SPEC_DIR}/../lib")
+$LOAD_PATH.unshift lib_path unless $LOAD_PATH.include?(lib_path)
+
+
+if File.exists?("spec/config.yml") == false
+  puts "Error. Please make sure that 'spec/config.yml' exists with the correct values before running the specs. See example file"
+  exit
+end
+
+config = YAML::load_file("spec/config.yml")
+WHATCD_USERNAME = config['whatcd_username']
+WHATCD_PASSWORD = config['whatcd_password']
+
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.formatter     = 'documentation'
+  config.mock_framework = :mocha
+  config.extend VCR::RSpec::Macros
+end
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/fixtures/cassette_library'
+  c.hook_into  :webmock
+  c.default_cassette_options = { :record => :none}
+
+  c.filter_sensitive_data('<WHATCD_USERNAME>') { WHATCD_USERNAME}
+  c.filter_sensitive_data('<WHATCD_PASSWORD>') { WHATCD_PASSWORD}
+end

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: rippy_rules
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Magnus Skog
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Ruby library for the What.cd api
+email:
+- mrcheese0@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rippy_rules.rb
+- lib/rippy_rules/rippy_rules.rb
+- lib/rippy_rules/version.rb
+- rippy_rules.gemspec
+- spec/config.yml.example
+- spec/lib/rippy_rules/rippy_rules_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/MrCheese/rippy_rules
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Ruby What.cd API
+test_files:
+- spec/config.yml.example
+- spec/lib/rippy_rules/rippy_rules_spec.rb
+- spec/spec_helper.rb