whatcd 0.1.0

data/lib/whatcd.rb

@@ -0,0 +1,84 @@
+require 'httparty'
+
+# Public: An API wrapper for What.cd's JSON API.
+class WhatCD
+  include HTTParty
+
+  base_uri 'what.cd'
+  maintain_method_across_redirects
+  format :json
+
+  class << self
+    # Public: Authenticates with the API. Keep in mind that you only have six
+    # tries!
+    #
+    # username - The username String.
+    # password - The password String.
+    #
+    # Raises an AuthError.
+    def authenticate(username, password)
+      body     = { username: username, password: password }
+      response = post '/login.php', body: body, 
+                 follow_redirects: false
+
+      if response.headers.has_key? 'set-cookie'
+        headers 'Cookie' => response.headers['set-cookie']
+      else
+        raise AuthError
+      end
+    end
+
+    # Public: Checks if there's properly authenticated.
+    #
+    # Returns a Boolean.
+    def authenticated?
+      headers.has_key? 'Cookie'
+    end
+
+    # Internal: Makes a request.
+    #
+    # action - An action name String.
+    # query  - A query Hash to send along (default: {}).
+    #
+    # Returns a Hash representing JSON. Raises an APIError.
+    def make_request(action, query = {})
+      raise AuthError unless authenticated?
+
+      result = get '/ajax.php', query: query.merge(action: action)
+
+      if result.code != 200 || result['status'] == 'failure'
+        raise(APIError)
+      else
+        result['response']
+      end
+    end
+
+    # Public: Make a request. The "method" name (capitalized!) is one of the
+    # API actions (ajax.php?action=<this-bit>).
+    #
+    # query - A query Hash.
+    #
+    # Examples
+    # 
+    #   WhatCD::User id => 666
+    #   # => <Hash ...>
+    #
+    # Signature
+    # 
+    #   Method(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
+      end
+    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

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: whatcd
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Paul Brickfeld
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: &2157115900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2157115900
+description: An API wrapper for What.cd's JSON API
+email:
+- paulbrickfeld@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/whatcd.rb
+homepage: http://britishtea.github.com/whatcd
+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.13
+signing_key: 
+specification_version: 3
+summary: An API wrapper for What.cd's JSON API
+test_files: []
+has_rdoc: