mollom_rest_api 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MWZiNDM0Mjg5ZGIyMmZhMTdmYWI4OWY3YTg0NWE4Mjk5OWNlZmI5Zg==
+  data.tar.gz: !binary |-
+    MjUxNGVkZDljYTU1ZDYyZWQyY2I0MTU3ZTU0Y2I4MWZmYWFiNmRjZA==
+SHA512:
+  metadata.gz: !binary |-
+    ZDE2NGFjNmM1ZWZhOGQyNWIwYjk5MzRmNDkxNGU1OGRmM2Q3NTUxNDVlNzk5
+    MzkyYWEyNDYyNWYzMTQ4ZDQ5YmFjMWZmZWY1NzFiYzc3NmZiODZkMWQ3MWE3
+    NjI5ZWExMjllODY0MGM1MjJhNTBjM2RkYzliNDhkMjVhZjA2MzE=
+  data.tar.gz: !binary |-
+    OWZmMzU1YWI0YzgyODk3NjMyODhjZDE0MWE2NDA4MTc2NTRlYWUwN2QwZGE1
+    YTBmZGIxNzNjYjczNGIzNzcwNDZkMzlhZTM2ZTY4YTIzNGU2ZDZkZWQ2YWJk
+    OWVjZDY4Y2JjMjc0ZTNkMmE4ODk2ZGI3MzE5NGY5MTMzNTY4YWQ=

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea
+.ruby-version
+.ruby-gemset
+.sass-cache
+log/test.log

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.2
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,18 @@
+source 'http://rubygems.org'
+
+gemspec
+
+gem 'coveralls', require: false
+
+group :development do
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'terminal-notifier-guard'
+end
+
+group :test do
+  gem 'rake'
+  gem 'rspec'
+  gem 'webmock'
+  gem 'vcr'
+end

data/Guardfile

@@ -0,0 +1,4 @@
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Krystian Czesak
+
+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,86 @@
+[![Build Status](https://travis-ci.org/Krystosterone/mollom_rest_api.svg?branch=master)](https://travis-ci.org/Krystosterone/mollom_rest_api)
+[![Coverage Status](https://coveralls.io/repos/Krystosterone/mollom_rest_api/badge.png?branch=master)](https://coveralls.io/r/Krystosterone/mollom_rest_api?branch=master)
+
+# Mollom Rest API
+
+mollom_rest_api is a ruby wrapper, using oauth authentication, for the [Mollom](https://mollom.com) Rest API.
+
+## Installation
+
+Add to your Gemfile:
+
+    gem 'mollom_rest_api'
+
+or install from Rubygems:
+
+    gem install mollom_rest_api
+
+## Usage
+
+Before using the gem, you must first configure it as such:
+
+```ruby
+MollomRestApi.url = 'http://rest.mollom.com' # Do not include the API version number
+MollomRestApi.public_key = 'my_public_key'
+MollomRestApi.private_key = 'my_private_key'
+MollomRestApi.oauth_options = {proxy: 'http://proxy.com:8888'} # some additional oauth options
+```
+
+You can get your public key and private key using Mollom's [site manager](https://mollom.com/user/130051/site-manager), after signing in.
+
+### Calling endpoints
+The gem implementation replicates the [Mollom's API Documentation](https://mollom.com/api) as much as possible.
+
+#### Example of API call
+
+Here is an example of how to verify a captcha using the gem.
+
+As per Mollom's Documentation on [verifying a captcha](https://mollom.com/api#captcha):
+
+```
+Syntax: POST http://rest.mollom.com/v1/captcha
+```
+
+- Path parameters
+  - **captchaId: The ID of the CAPTCHA resource.**
+- Request parameters
+  - **solution:**
+    - **The answer provided by the author.**
+  - authorName: (optional)
+    - The name of the content author.
+  - authorUrl: (optional)
+    - The homepage/website URL of the content author.
+  - authorMail: (optional)
+    - The e-mail address of the content author.
+  - authorIp: (optional)
+    - The IP address of the content author.
+  - authorId: (optional)
+    - The local user ID of the content author on the client site.
+  - authorOpenid: (multiple, optional)
+    - One or more Open IDs of the content author.
+  - rateLimit: (optional, default = 15)
+     - Seconds that must have passed by for the same author to post again.
+  - honeypot: (optional)
+     - Client-side honeypot value, if non-empty.
+
+As such, `captchaId` and `solution` must both be specified for the endpoint call to succeed. All other parameters are optional, and can be passed to the call using a hash.
+
+Using the gem, we call this endpoint using:
+
+```ruby
+MollomRestApi::V1::Captcha.verify("captchaId", "solution", {authorName: "Bob", ...})
+```
+
+or using the alternative syntax:
+
+```ruby
+MollomRestApi::V1::verify_captcha("captchaId", "solution", {authorName: "Bob", ...})
+```
+
+### Running Tests
+
+`bundle exec rspec spec` - Running specs (all web interactions are mocked with VCR cassettes)
+
+### Contributors
++ [royjs](https://github.com/royjs)
++ [krystosterone](https://github.com/krystosterone)

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec

data/lib/mollom_rest_api/exceptions.rb

@@ -0,0 +1,12 @@
+module MollomRestApi
+  class ApiException < StandardError
+    attr_reader :error_code
+
+    def initialize(message, error_code)
+      super(message)
+      @error_code = error_code
+    end
+  end
+
+  class MissingConfig < StandardError; end
+end

data/lib/mollom_rest_api/interface.rb

@@ -0,0 +1,81 @@
+class MollomRestApi::Interface
+  REQUEST_HEADERS = {'Accept' => 'application/json'}
+  MANDATORY_CONFIGURATIONS = %w(url public_key private_key)
+
+  class << self
+    protected
+
+    def results_key
+      path_from_class_name
+    end
+
+    def path
+      path_from_class_name
+    end
+
+    def version
+      version_from_class_name
+    end
+
+    def post(request_parameters = {}, path_parameters = [])
+      request(:post, request_parameters, path_parameters)
+    end
+
+    def get(request_parameters = {}, path_parameters = [])
+      request(:get, request_parameters, path_parameters)
+    end
+
+    private
+
+    def request(http_method, request_parameters, path_parameters)
+      ensure_configuration_is_valid!
+
+      request_arguments = request_arguments(http_method, path, path_parameters, request_parameters, version)
+      response = MollomRestApi.oauth_access_token.request(http_method, *request_arguments)
+
+      throw_api_exception_using(response) unless response.code == '200'
+
+      computed_results_key = method_that_called_the_api_operation == 'list' ? 'list' : results_key
+      JSON.parse(response.body)[computed_results_key]
+    end
+
+    def ensure_configuration_is_valid!
+      MANDATORY_CONFIGURATIONS.each do |config|
+        raise MollomRestApi::MissingConfig.new("Missing #{config}.") if MollomRestApi.send(config).nil?
+      end
+    end
+
+    def request_arguments(http_method, path, path_parameters, request_parameters, version)
+      url = url(path_parameters, version, path)
+
+      if http_method == :get
+        ["#{url}?#{request_parameters.to_query}", REQUEST_HEADERS]
+      elsif http_method == :post
+        [url, request_parameters, REQUEST_HEADERS]
+      end
+    end
+
+    def url(path_parameters, version, path)
+      path_parameters << 'delete' if method_that_called_the_api_operation == 'delete'
+      url_path = [path, path_parameters].flatten.compact.join('/')
+      "#{MollomRestApi.url}/#{version}/#{url_path}"
+    end
+
+    def method_that_called_the_api_operation
+      index = caller.index { |callstack| callstack[/`([^']*)'/, 1] == 'request' }
+      caller[index + 2][/`([^']*)'/, 1]
+    end
+
+    def version_from_class_name
+      self.name.split('::')[-2].downcase
+    end
+
+    def path_from_class_name
+      self.name.split('::').last.underscore
+    end
+
+    def throw_api_exception_using(response)
+      raise MollomRestApi::ApiException.new(response.body, response.code.to_i)
+    end
+  end
+end

data/lib/mollom_rest_api/v1/blacklist.rb

@@ -0,0 +1,29 @@
+class MollomRestApi::V1::Blacklist < MollomRestApi::Interface
+  class << self
+    def create(public_key, value, request_parameters = {})
+      post(request_parameters.reverse_merge(value: value), [public_key])
+    end
+
+    def update(public_key, blacklist_entry_id, request_parameters = {})
+      post(request_parameters, [public_key, blacklist_entry_id])
+    end
+
+    def delete(public_key, blacklist_entry_id)
+      post({}, [public_key, blacklist_entry_id])
+    end
+
+    def list(public_key, request_parameters = {})
+      get(request_parameters, [public_key])
+    end
+
+    def read(public_key, blacklist_entry_id)
+      get({}, [public_key, blacklist_entry_id])
+    end
+
+    protected
+
+    def results_key
+      'entry'
+    end
+  end
+end

data/lib/mollom_rest_api/v1/captcha.rb

@@ -0,0 +1,11 @@
+class MollomRestApi::V1::Captcha < MollomRestApi::Interface
+  class << self
+    def create(type = 'image', request_parameters = {})
+      post(request_parameters.reverse_merge(type: type))
+    end
+
+    def verify(captcha_id, solution, request_parameters = {})
+      post(request_parameters.reverse_merge(solution: solution), captcha_id)
+    end
+  end
+end

data/lib/mollom_rest_api/v1/content.rb

@@ -0,0 +1,12 @@
+class MollomRestApi::V1::Content < MollomRestApi::Interface
+  class << self
+    def create(request_parameters = {})
+      post(request_parameters)
+    end
+    alias_method :check, :create
+
+    def update(content_id, request_parameters = {})
+      post(request_parameters, [content_id])
+    end
+  end
+end

data/lib/mollom_rest_api/v1/feedback.rb

@@ -0,0 +1,14 @@
+class MollomRestApi::V1::Feedback < MollomRestApi::Interface
+  class << self
+    def create(reason, request_parameters = {})
+      raise_missing_parameter_error unless request_parameters.include?(:contentId) ^ request_parameters.include?(:captchaId)
+      post(request_parameters.reverse_merge(reason: reason))
+    end
+
+    private
+
+    def raise_missing_parameter_error
+      raise ArgumentError.new("Specify one of two parameters: contentId or captchaId.")
+    end
+  end
+end

data/lib/mollom_rest_api/v1/site.rb

@@ -0,0 +1,23 @@
+class MollomRestApi::V1::Site < MollomRestApi::Interface
+  class << self
+    def create(url, email, request_parameters = {})
+      post(request_parameters.reverse_merge(url: url, email: email))
+    end
+
+    def update(public_key, request_parameters = {})
+      post(request_parameters, [public_key])
+    end
+
+    def list(request_parameters = {})
+      get(request_parameters)
+    end
+
+    def read(public_key)
+      get({}, [public_key])
+    end
+
+    def delete(public_key)
+      post({}, [public_key])
+    end
+  end
+end

data/lib/mollom_rest_api/v1/whitelist.rb

@@ -0,0 +1,29 @@
+class MollomRestApi::V1::Whitelist < MollomRestApi::Interface
+  class << self
+    def create(public_key, value, context, request_parameters = {})
+      post(request_parameters.reverse_merge(value: value, context: context), [public_key])
+    end
+
+    def update(public_key, whitelist_entry_id, request_parameters = {})
+      post(request_parameters, [public_key, whitelist_entry_id])
+    end
+
+    def delete(public_key, whitelist_entry_id)
+      post({}, [public_key, whitelist_entry_id])
+    end
+
+    def list(public_key, request_parameters = {})
+      get(request_parameters, [public_key])
+    end
+
+    def read(public_key, whitelist_entry_id)
+      get({}, [public_key, whitelist_entry_id])
+    end
+
+    protected
+
+    def results_key
+      'entry'
+    end
+  end
+end

data/lib/mollom_rest_api/v1.rb

@@ -0,0 +1,3 @@
+module MollomRestApi
+  class V1 < VersionedApi; end
+end

data/lib/mollom_rest_api/version.rb

@@ -0,0 +1,3 @@
+module MollomRestApi
+  VERSION = '0.1.0'
+end

data/lib/mollom_rest_api/versioned_api.rb

@@ -0,0 +1,51 @@
+module MollomRestApi
+  class VersionedApi
+    class << self
+      def method_missing(method_name, *arguments, &block)
+        if handles_api_call?(method_name)
+          target_class = extract_class_from(method_name)
+          target_method = extract_method_from(method_name)
+          target_class.send(target_method, *arguments)
+        else
+          super
+        end
+      end
+
+      def respond_to?(method_name, include_private = false)
+        if handles_api_call?(method_name)
+          true
+        else
+          super
+        end
+      end
+
+      private
+
+      def handles_api_call?(method_name)
+        target_class = extract_class_from(method_name)
+        return false if target_class.nil?
+
+        target_method = extract_method_from(method_name)
+
+        receiver_public_methods_of(target_class).include?(target_method.to_sym)
+      end
+
+      def receiver_public_methods_of(klass)
+        klass.public_methods(false) & klass.methods(false)
+      end
+
+      def extract_class_from(method_name)
+        interface_name = method_name.to_s.split('_').last
+        class_name = interface_name.camelize
+        return unless self.const_defined?(class_name)
+
+        target_class_name = "#{self.name}::#{class_name}"
+        target_class_name.constantize
+      end
+
+      def extract_method_from(method_name)
+        method_name.to_s.split('_').first
+      end
+    end
+  end
+end

data/lib/mollom_rest_api.rb

@@ -0,0 +1,31 @@
+require 'oauth'
+require 'json'
+require 'active_support/all'
+
+module MollomRestApi
+  require 'mollom_rest_api/version'
+  require 'mollom_rest_api/exceptions'
+  require 'mollom_rest_api/interface'
+  require 'mollom_rest_api/versioned_api'
+  require 'mollom_rest_api/v1'
+  require 'mollom_rest_api/v1/content'
+  require 'mollom_rest_api/v1/captcha'
+  require 'mollom_rest_api/v1/feedback'
+  require 'mollom_rest_api/v1/site'
+  require 'mollom_rest_api/v1/blacklist'
+  require 'mollom_rest_api/v1/whitelist'
+
+  class << self
+    attr_accessor :url, :public_key, :private_key, :oauth_options
+
+    def oauth_access_token
+      @oauth_access_token ||= OAuth::AccessToken.new(oauth_consumer)
+    end
+
+    private
+
+    def oauth_consumer
+      OAuth::Consumer.new(public_key, private_key, @oauth_options || {})
+    end
+  end
+end

data/mollom_rest_api.gemspec

@@ -0,0 +1,21 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mollom_rest_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mollom_rest_api"
+  spec.version       = MollomRestApi::VERSION
+  spec.authors       = ["Jean-Sébastien Roy", "Krystian Czesak"]
+  spec.email         = ["mollom.gem@gmail.com"]
+  spec.description   = %q{A ruby wrapper for the Mollom Rest API.}
+  spec.summary       = %q{A ruby wrapper for the Mollom Rest API.}
+  spec.homepage      = ""
+  spec.license       = ""
+
+  spec.files         = `git ls-files`.split($/)
+  spec.test_files    = spec.files.grep(%r{^(spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'oauth'
+  spec.add_dependency 'activesupport'
+end

data/spec/fixtures/cassette_library/blacklist/create.yml

@@ -0,0 +1,43 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://dev.mollom.com/v1/blacklist/1lgj17lzuezlu1bn9ry4k3qz4k8nr42n
+    body:
+      encoding: US-ASCII
+      string: context=allFields&value=text
+    headers:
+      Accept:
+      - application/json
+      User-Agent:
+      - OAuth gem v0.4.7
+      Content-Length:
+      - '0'
+      Content-Type:
+      - application/x-www-form-urlencoded
+      Authorization:
+      - OAuth oauth_consumer_key="b06465615b3a8800ef79ca947b1addca", oauth_nonce="CP19Jf3MxtPxat0k5E4CARZ6PQJIZ8wsLkikBtbk",
+        oauth_signature="B0Cp%2FbPpz9ZaniKQ0Cbx5Z5WIuw%3D", oauth_signature_method="HMAC-SHA1",
+        oauth_timestamp="1409677740", oauth_version="1.0"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      X-Powered-By:
+      - Servlet/3.0 JSP/2.2 (GlassFish Server Open Source Edition 3.1.2.2 Java/Oracle
+        Corporation/1.7)
+      Server:
+      - GlassFish Server Open Source Edition 3.1.2.2
+      Content-Type:
+      - application/json
+      Date:
+      - Tue, 02 Sep 2014 17:09:45 GMT
+      Connection:
+      - close
+    body:
+      encoding: US-ASCII
+      string: ! '{"code":"200","entry":{"context":"allFields","created":"1409677772829","id":"41a0e033-3d6a-465b-87d5-1ef60476da62","match":"contains","note":"","reason":"unwanted","status":"1","value":"text"}}'
+    http_version: 
+  recorded_at: Tue, 02 Sep 2014 17:09:00 GMT
+recorded_with: VCR 2.9.2

data/spec/fixtures/cassette_library/blacklist/delete.yml

@@ -0,0 +1,43 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://dev.mollom.com/v1/blacklist/1lgj17lzuezlu1bn9ry4k3qz4k8nr42n/42a51362-bab6-4256-8e28-60d5df568250/delete
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json
+      User-Agent:
+      - OAuth gem v0.4.7
+      Content-Length:
+      - '0'
+      Content-Type:
+      - application/x-www-form-urlencoded
+      Authorization:
+      - OAuth oauth_consumer_key="b06465615b3a8800ef79ca947b1addca", oauth_nonce="YRrT2k8Ld5HxTavGNav7MvTFo5se6fUC9syL2UvwPUM",
+        oauth_signature="v%2BCn79%2F6kiO6FTnGDklgaygcA8M%3D", oauth_signature_method="HMAC-SHA1",
+        oauth_timestamp="1410368605", oauth_version="1.0"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      X-Powered-By:
+      - Servlet/3.0 JSP/2.2 (GlassFish Server Open Source Edition 3.1.2.2 Java/Oracle
+        Corporation/1.7)
+      Server:
+      - GlassFish Server Open Source Edition 3.1.2.2
+      Content-Type:
+      - application/json
+      Date:
+      - Wed, 10 Sep 2014 17:04:16 GMT
+      Connection:
+      - close
+    body:
+      encoding: US-ASCII
+      string: ! '{"code":"200"}'
+    http_version: 
+  recorded_at: Wed, 10 Sep 2014 17:03:25 GMT
+recorded_with: VCR 2.9.2

data/spec/fixtures/cassette_library/blacklist/list.yml

@@ -0,0 +1,39 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://dev.mollom.com/v1/blacklist/1lgj17lzuezlu1bn9ry4k3qz4k8nr42n?count=5
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json
+      User-Agent:
+      - OAuth gem v0.4.7
+      Authorization:
+      - OAuth oauth_consumer_key="b06465615b3a8800ef79ca947b1addca", oauth_nonce="bxGeBFEd7ZBEwW7C9zHKPgIAs0dJ1thMdBUSpuoco4",
+        oauth_signature="UiA35v%2FZIgyxCD2L1i%2B5MG7VxsE%3D", oauth_signature_method="HMAC-SHA1",
+        oauth_timestamp="1410374054", oauth_version="1.0"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      X-Powered-By:
+      - Servlet/3.0 JSP/2.2 (GlassFish Server Open Source Edition 3.1.2.2 Java/Oracle
+        Corporation/1.7)
+      Server:
+      - GlassFish Server Open Source Edition 3.1.2.2
+      Content-Type:
+      - application/json
+      Date:
+      - Wed, 10 Sep 2014 18:35:04 GMT
+      Connection:
+      - close
+    body:
+      encoding: US-ASCII
+      string: ! '{"code":"200","list":{"entry":[{"context":"allFields","created":"1410369319158","id":"eafc878d-94f7-462d-bb67-49d5170a9a71","match":"contains","note":"","reason":"unwanted","status":"1","value":"patate-chaude"},{"context":"allFields","created":"1410369319342","id":"975805c8-ee06-4750-8cda-ec5626712c50","match":"contains","note":"","reason":"unwanted","status":"1","value":"system_32"}]},"listOffset":"0","listCount":"2","listTotal":"2"}'
+    http_version: 
+  recorded_at: Wed, 10 Sep 2014 18:34:14 GMT
+recorded_with: VCR 2.9.2