whatcd 0.1.5 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cb8d083335ae85367be54b14155d42b7c29b9070
+  data.tar.gz: c8fe42b6b6423b25ed7b77a4159a5c65265c198a
+SHA512:
+  metadata.gz: ecc1bb291168579a900a2b1c8babae840ea16b906094b125a149d714aa50b36745bf7dbd7c6db87ed925f650d37cce379cc1cf29e2599aac68928ac05ca70469
+  data.tar.gz: 0d69c9c25b509d67ab326d29e298b6c4b0a13ee91530efd4acf5ebc669fbb4464af2f81da0ab107fa3cf52753f6aa84bb9bd889b75c1fe5292ae07bfc04c4251

data.tar.gz.sig

@@ -0,0 +1,6 @@
+nvs�@�>f�U۠C�=�W�I��m�
+��g�`X�W,^Z"@�R+Yi�o��mw1}�|uw�A��l�̓n%��95>{�mC���6���+�����,�-g9�I��w�5�єL]ݴ��#����
+DJ�m�W��5���n&ô6Fҷp�����Ǟ�
+�;u�(��{_��`��K���8�++�	Ċ����_��+�Mt��&�`�2ن[σ<ajމO>�Ǜ�
+0z]v���f&��]
+�

data/lib/whatcd.rb

@@ -1,127 +1,88 @@
-require 'httparty'
+require "faraday"
+require "faraday-cookie_jar"
+require "json"
 
 # Public: An API wrapper for What.cd's JSON API.
 #
 # Examples
 # 
-#   WhatCD::authenticate 'username', 'password'
+#   client = WhatCD::Client.new 'username', 'password'
 #   
-#   WhatCD::User :id => 666
+#   client.fetch :user, :id => 666
 #   => { ... }
 #   
-#   WhatCD::Browse :searchstr => 'The Flaming Lips'
+#   client.fetch :browse, :searchstr => 'The Flaming Lips'
 #   => { ... }
 class WhatCD
-  include HTTParty
+  AuthError = Class.new StandardError
+  APIError  = Class.new StandardError
 
-  base_uri 'https://what.cd'
-  maintain_method_across_redirects
-  format :json
+  class Client
+    attr_reader :connection
 
-  class << self
-    # Public: Authenticates with the API. Keep in mind that you only have six
-    # tries!
-    #
-    # username - The username String.
-    # password - The password String.
-    #
-    # Returns a HTTParty::CookieHash. Raises an AuthError.
-    def authenticate(username, password)
-      body     = { username: username, password: password, keeplogged: 1 }
-      response = post '/login.php', body: body, 
-                 follow_redirects: false
-
-      if response.headers.has_key? 'set-cookie'
-        cookie_jar = HTTParty::CookieHash.new
-        cookie_jar.add_cookies response.headers['set-cookie']
+    def initialize(username = nil, password = nil)
+      @connection = Faraday.new(:url => "https://what.cd") do |builder|
+        builder.request :url_encoded
+        builder.use :cookie_jar
+        builder.adapter Faraday.default_adapter
+      end
 
-        cookies cookie_jar
-      else
-        raise AuthError
+      unless username.nil? || password.nil?
+        authenticate username, password 
       end
     end
 
-    # Public: Checks if there's properly authenticated.
-    #
-    # Returns a Boolean.
-    def authenticated?
-      cookies.has_key? :session
-    end
+    def authenticate(username, password)
+      body = { :username => username, :password => password, :keeplogged => 1 }
+      res  = connection.post "/login.php", body
 
-    # Public: Makes a request. The "method" name (capitalized!) is one of the
-    # API actions (ajax.php?action=<this-bit>).
-    #
-    # query - A query Hash.
-    #
-    # Returns a Hash. Raises an AuthError or APIError.
-    #
-    # Examples
-    # 
-    #   WhatCD::User :id => 666
-    #   # => <Hash ...>
-    #
-    # Signature
-    # 
-    #   Action(query)
-    def method_missing(method, *args, &block)
-      if method.to_s == method.to_s.capitalize
-        make_request method.to_s.downcase, args.first
-      else
-        super
+      unless res["set-cookie"] && res["location"] == "index.php"
+        raise AuthError
       end
+
+      @authenticated = true
     end
 
-    # Public: Makes a request without a query. See method_missing for usage.
-    #
-    # Returns a String or Hash. Raises an AuthError or APIError.
-    def const_missing(constant)
-      # Rippy's response differs from the other respones.
-      constant == :Rippy ? rippy : make_request(constant.to_s.downcase)
+    def set_cookie(cookie)
+      connection.headers["Cookie"] = cookie
+      @authenticated = true
     end
 
-  private
+    def authenticated?
+      @authenticated
+    end
 
-    # Internal: Makes a request.
+    # Public: Fetches a resource. For all possible resources and parameters see
+    # https://github.com/WhatCD/Gazelle/wiki/JSON-API-Documentation.
     #
-    # action - An action name String.
-    # query  - A query Hash to send along (default: {}).
+    # resource   - A resource name Symbol (ajax.php?action=<this part>).
+    # parameters - A Hash.
     #
-    # Returns a Hash representing JSON. Raises an AuthError or APIError.
-    def make_request(action, query = {})
-      raise AuthError unless authenticated?
+    # Returns a Hash.
+    # Raises AuthError when not authenticated yet.
+    # Raises AuthError when redirected to /login.php.
+    # Raises APIError when a HTTP error occurs.
+    # Raises APIError when the response body is `{"status": "failure"}`.
+    def fetch(resource, parameters = {})
+      unless authenticated?
+        raise AuthError
+      end
 
-      result = get '/ajax.php', query: query.merge(action: action)
+      res = connection.get "ajax.php", parameters.merge(:action => resource)
 
-      if result.code != 200 || result['status'] == 'failure'
-        raise APIError
-      else
-        result['response']
+      if res.status == "302" && res["location"] == "login.php"
+        raise AuthError
+      elsif !res.success?
+        raise APIError, res.status
       end
-    end
 
-    # Internal: Gets a Rippy quote.
-    #
-    # json - A Boolean indicating wether or not the return value should be
-    #        JSON (default: false).
-    #
-    # Returns a String or Hash.
-    def rippy(json = false)
-      raise AuthError unless authenticated?
+      parsed_res = JSON.parse res.body
 
-      result = get '/ajax.php', query: { action: 'rippy', format: 'json' }
-      
-      if result.code != 200 || result['status'] == 'failure'
-        raise(APIError)
-      else
-        json ? result : result['rippy']
+      if parsed_res["status"] == "failure"
+        raise APIError
       end
+
+      parsed_res["response"]
     end
   end
-
-  # Internal: Gets raised whenever failure occured. Error messages will be
-  # vague, as What.cd's API doesn't give any reasons for failure.
-  class APIError < Exception; end
-
-  # Internal: Gets raised when a request is made without authenticating first.
-  class AuthError < Exception; end
 end

metadata

@@ -1,30 +1,77 @@
 --- !ruby/object:Gem::Specification
 name: whatcd
 version: !ruby/object:Gem::Version
-  version: 0.1.5
-  prerelease: 
+  version: 0.2.0
 platform: ruby
 authors:
 - Paul Brickfeld
 autorequire: 
 bindir: bin
-cert_chain: []
-date: 2012-08-23 00:00:00.000000000 Z
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDhTCCAm2gAwIBAgIBATANBgkqhkiG9w0BAQUFADBEMRYwFAYDVQQDDA1qaXB2
+  YW5yZWlqc2VuMRUwEwYKCZImiZPyLGQBGRYFZ21haWwxEzARBgoJkiaJk/IsZAEZ
+  FgNjb20wHhcNMTMwODA4MjEzMDE4WhcNMTQwODA4MjEzMDE4WjBEMRYwFAYDVQQD
+  DA1qaXB2YW5yZWlqc2VuMRUwEwYKCZImiZPyLGQBGRYFZ21haWwxEzARBgoJkiaJ
+  k/IsZAEZFgNjb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQClzSDD
+  gHU5xJorLZBEClUFIQsAVUToqrIY25G50wd3tRRitsD4+8TKNcH/afmTZ7itFd47
+  Y38wLZHJ3QGNWWUzKSp75hwY1YjFT/WTt2CBU/Yisawy2Ah04fEDDNtXnUm/a4Nf
+  cm1iJCSO0gYqihYx/cjt8ZzMUZGQc0HjYg7jzOGOdjsozJDUtrPK+7njgJeRznBu
+  Zglx4JcSvSnUe3KnZYiHUAfNMbHZC6aDoWJNEJWIugDOC4ERFDQTl3u6X4WtMgK0
+  veZT7x84/+o2OAkXrj6Vbz4idyFlaOi+4yl5b0YJLZdzHSZEIoROzELt3kfRYIUe
+  +KW3UGk4RtI/zzO1AgMBAAGjgYEwfzAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAd
+  BgNVHQ4EFgQUVokOPAdYy4XiyylEpkAbiU8TclUwIgYDVR0RBBswGYEXamlwdmFu
+  cmVpanNlbkBnbWFpbC5jb20wIgYDVR0SBBswGYEXamlwdmFucmVpanNlbkBnbWFp
+  bC5jb20wDQYJKoZIhvcNAQEFBQADggEBADg9YN9UgiC7XpRuWGs/CP1sRXuiKFHL
+  sZCWGXivJK5VVIjUAABVDU0bG8z7kf8k2LMoXY2reVjhdKjrYYkFVMqY0U207xMA
+  seECzepUAXMMbLtppejnTNoIgz+w6nNfIwTutKdLx8xXGpa3z5AqYdmCWfuIj77G
+  3T7twg/E2UReEgkHWULU05ISp0SODfCJzq21nKReppwVumyGBmyCOBz+uM27OXxc
+  336lVuJ9KEoETd0t0biCkWVE2illvjAj0HuCi4mSA5QRkr2FbWkgFQXiMAcaakcW
+  xr2cJv1xwkNLUhdO3OoK0ix8tfsubY0PhA8xi8a016pr7xYJD+xUPiA=
+  -----END CERTIFICATE-----
+date: 2014-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: httparty
+  name: faraday
   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'
+- !ruby/object:Gem::Dependency
+  name: faraday-cookie_jar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: cutest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: An API wrapper for What.cd's JSON API
@@ -35,28 +82,27 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/whatcd.rb
-homepage: http://britishtea.github.com/whatcd
+homepage: http://github.com/britishtea/whatcd
 licenses: []
+metadata: {}
 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.23
+rubygems_version: 2.2.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: An API wrapper for What.cd's JSON API
 test_files: []

metadata.gz.sig

@@ -0,0 +1 @@
+oA^�T������|��ߊ���J��f�㿗U�|����KEbKMֶ`�0��tD[�i4����Y/����*�N��M9�O����=��ʁ��U��`؂�v*Z}�sK�'�d��^A��%�{