commentatr 0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+coverage

data/.rspec

@@ -0,0 +1 @@
+--colour

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in commentatr_client.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Gregory Eremin
+
+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,106 @@
+## Ruby wrapper for [Commentatr API](http://commentatr.net/developer/documentation/)
+This gem supports ruby version 1.9+ only.
+
+### Installation
+
+Add this line to your application's Gemfile:
+```ruby
+gem 'commentatr'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install commentatr
+```
+
+### Usage
+
+Initialize client
+```ruby
+# Without params
+Commentatr::Client.new()
+
+# With blog credentials
+Commentatr::Client.new(partner_host: "example.com", token: "...your secret token...")
+
+# With client credentials
+Commentatr::Client.new(client_id: 42, token: "...your secret token...")
+```
+
+Fetch comments for blog
+```ruby
+# All entry comments
+cttr.comments(page_id: "blog-1")
+
+# Last 5 entry comments
+cttr.comments(page_id: "blog-1", order: "desc", limit: 5)
+
+# All comments since last time you checked
+cttr.comments(page_id: "blog-1", after: Time.now.to_i - 3600)
+```
+
+Fetch comments for all client blogs
+```ruby
+cttr.client_comments(order: "asc", offset: 100, limit: 10)
+```
+
+Fetch counters of comments for each entry of each client blog
+```ruby
+cttr.counters
+```
+
+Moderator actions
+```ruby
+cttr.approve(comment_id: 1)
+cttr.reject(comment_id: 2)
+cttr.delete(comment_id: 3)
+cttr.junk(comment_id: 4)
+
+# Mass management
+cttr.approve(comment_id: [1, 2, 3, 4])
+```
+
+Admin actions
+```ruby
+# Change comments approval setting
+cttr = Commentatr::Client.new(partner_host: "example.com", token: "...your secret token...")
+cttr.update_config(approval: false, readonly: true)
+
+# Regenerate blog token
+commentatr_config[:token] = cttr.regenerate_blog_token(partner_host: "example.com")
+
+# Regenerate client token
+commentatr_config[:token] = cttr.regenerate_client_token
+```
+
+You can perform all these actions passing all needed authentication params for each query
+```ruby
+cttr = Commentatr::Client.new
+cttr.comments(
+  partner_host: "example.com",
+  token: "...your secret token...",
+  page_id: "blog-1",
+  order: "asc",
+  offset: 50,
+  limit: 10
+)
+```
+
+### Working with responses
+All responses are stored in `Commentatr::Response` objects
+```ruby
+response = cttr.comments(page_id: "blog-1")
+response.code
+# => 200
+response.body.success
+# => true
+response.body.data
+# => [ ...comments here... ]
+response.body.errors
+# => []
+```

data/Rakefile

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

data/commentatr.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/commentatr/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Gregory Eremin"]
+  gem.email         = ["magnolia_fan@me.com"]
+  gem.description   = %q{Ruby wrapper for Commentatr API}
+  gem.summary       = %q{Gem provides easy access to Commentatr API web service}
+  gem.homepage      = "http://commentatr.net/developer/gem"
+
+  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{^spec/})
+  gem.name          = "commentatr"
+  gem.require_paths = ["lib"]
+  gem.version       = Commentatr::VERSION
+
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "webmock"
+  gem.add_development_dependency "simplecov"
+  gem.add_development_dependency "awesome_print"
+end

data/lib/commentatr.rb

@@ -0,0 +1,8 @@
+require "net/http"
+require "json"
+
+require "commentatr/version"
+require "commentatr/request"
+require "commentatr/response"
+require "commentatr/routes"
+require "commentatr/client"

data/lib/commentatr/client.rb

@@ -0,0 +1,60 @@
+module Commentatr
+class Client
+  attr_accessor :client_id, :token, :partner_host, :page_id
+
+  def initialize(params = {})
+    %w[ client_id token partner_host page_id ].each { |param|
+      instance_variable_set("@#{param}", params[param.to_sym]) unless params[param.to_sym].nil?
+    }
+  end
+
+  Commentatr::ROUTES.each { |name, params|
+    define_method(name) do |args = {}|
+      exec_mathod(params, args)
+    end
+  }
+
+private
+
+  def exec_mathod(params, args = {})
+    args.merge!(instance_variables.map{ |key|
+      { key.to_s.gsub("@", "").to_sym => instance_variable_get(key) }
+    }.inject(:merge) || {})
+
+    params[:uri_params] = params[:uri].scan(/:\w+/).map{ |param|
+      param.gsub(":", "").to_sym
+    }
+    params[:required_params] ||= []
+    params[:optional_params] ||= []
+    validate_params(params, args)
+
+    uri = params[:uri].clone
+    params[:uri_params].each { |key|
+      uri.gsub!(":#{key}", args.delete(key))
+    }
+
+    case params[:method]
+    when :get, :delete
+      get_params = args
+      post_params = {}
+    when :post, :put
+      get_params = {}
+      post_params = args
+    end
+
+    Commentatr::Request.new(params[:method], uri, get_params, post_params).make
+  end
+
+  def validate_params(params, args)
+    required_params = (params[:uri_params] + params[:required_params]).uniq
+    required_params.each { |key|
+      raise "Parameter required: #{key}" unless args.keys.include?(key)
+    }
+
+    allowed_params = (required_params + params[:optional_params]).uniq
+    args.keys.each { |key|
+      raise "Unknown parameter: #{key}" unless allowed_params.include?(key)
+    }
+  end
+end
+end

data/lib/commentatr/request.rb

@@ -0,0 +1,35 @@
+module Commentatr
+class Request
+  HOST = "api.commentatr.net"
+  PORT = 80
+
+  attr_accessor :method, :uri, :get_params, :post_params
+  attr_reader :response
+
+  def initialize(method, uri, get_params = {}, post_params = {})
+    @method, @uri, @get_params, @post_params = method, uri, get_params, post_params
+    @response = nil
+  end
+
+  def make
+    uri = @uri + ("?" + uri_params(@get_params) unless @get_params.empty?).to_s
+
+    http = ::Net::HTTP.start(HOST, PORT)
+    response = http.send_request(@method.to_s.upcase, uri, uri_params(@post_params))
+
+    begin
+      body = JSON.parse(response.body)
+    rescue
+      body = nil
+    end
+
+    @response = Commentatr::Response.new(response.code.to_i, body)
+  end
+
+private
+
+  def uri_params(params)
+    params.map { |key, value| "#{key}=#{value}" }.join("&")
+  end
+end
+end

data/lib/commentatr/response.rb

@@ -0,0 +1,20 @@
+module Commentatr
+class Response
+  attr_reader :code, :body
+
+  def initialize(code, body)
+    @code = code
+    unless body.nil?
+      @body = ResponseBody.new(body["success"], body["data"], body["errors"])
+    end
+  end
+
+  class ResponseBody
+    attr_reader :success, :data, :errors
+
+    def initialize(success, data, errors)
+      @success, @data, @errors = success, data, errors
+    end
+  end
+end
+end

data/lib/commentatr/routes.rb

@@ -0,0 +1,61 @@
+module Commentatr
+  ROUTES = {
+    comments: {
+      method: :get,
+      uri: "/api/blogs/:partner_host/pages/:page_id/comments.json",
+      optional_params: [:order, :limit, :after, :token]
+    },
+    client_comments: {
+      method: :get,
+      uri: "/api/clients/:client_id/comments.json",
+      required_params: [:token],
+      optional_params: [:order, :limit, :after]
+    },
+    counters: {
+      method: :get,
+      uri: "/api/clients/:client_id/counters.json",
+      required_params: [:token]
+    },
+    delete: {
+      method: :delete,
+      uri: "/api/blogs/:partner_host/pages/:page_id/comments/:comment_id.json",
+      required_params: [:token]
+    },
+    approve: {
+      method: :put,
+      uri: "/api/blogs/:partner_host/pages/:page_id/comments/:comment_id/approve.json",
+      required_params: [:token]
+    },
+    reject: {
+      method: :put,
+      uri: "/api/blogs/:partner_host/pages/:page_id/comments/:comment_id/reject.json",
+      required_params: [:token]
+    },
+    junk: {
+      method: :put,
+      uri: "/api/blogs/:partner_host/pages/:page_id/comments/:comment_id/junk.json",
+      required_params: [:token]
+    },
+    regenerate_blog_token: {
+      method: :get,
+      uri: "/api/blogs/:partner_host/regenerate_token.json",
+      required_params: [:token]
+    },
+    regenerate_client_token: {
+      method: :get,
+      uri: "/api/clients/:client_id/regenerate_token.json",
+      required_params: [:token]
+    },
+    update_config: {
+      method: :put,
+      uri: "/api/blogs/:partner_host/update_config.json",
+      required_params: [:token],
+      optional_params: [:approval, :readonly]
+    },
+    client_tokens: {
+      method: :get,
+      uri: "/api/clients/:client_id/tokens.json",
+      required_params: [:token]
+    }
+  }
+end

data/lib/commentatr/version.rb

@@ -0,0 +1,3 @@
+module Commentatr
+  VERSION = "0.1"
+end

data/spec/requests/comments_spec.rb

@@ -0,0 +1,39 @@
+require "spec_helper"
+
+describe "Comments method" do
+  it "works with preconfigured partner_host" do
+    stub_request(:get, "http://#{$commentatr_host}/api/blogs/example.com/pages/1/comments.json").
+      to_return(status: 200, body: { success: true, data: nil, errors: [] }.to_json)
+
+    commentatr = Commentatr::Client.new(partner_host: "example.com")
+    commentatr.comments(page_id: "1")
+  end
+
+  it "works with preconfigured partner_host and page_id" do
+    stub_request(:get, "http://#{$commentatr_host}/api/blogs/example.com/pages/1/comments.json").
+      to_return(status: 200, body: { success: true, data: nil, errors: [] }.to_json)
+    commentatr = Commentatr::Client.new(partner_host: "example.com", page_id: "1")
+    commentatr.comments
+  end
+
+  it "works without preconfigured partner_host and page_id" do
+    stub_request(:get, "http://#{$commentatr_host}/api/blogs/example.com/pages/1/comments.json").
+      to_return(status: 200, body: { success: true, data: nil, errors: [] }.to_json)
+    commentatr = Commentatr::Client.new
+    commentatr.comments(partner_host: "example.com", page_id: "1")
+  end
+
+  it "updates comment" do
+    stub_request(:put, "http://#{$commentatr_host}/api/blogs/example.com/pages/1/comments/test/approve.json").
+      to_return(status: 200, body: { success: true, data: nil, errors: [] }.to_json)
+    commentatr = Commentatr::Client.new(partner_host: "example.com", token: "test")
+    commentatr.approve(page_id: "1", comment_id: "test")
+  end
+
+  it "handles bad responses" do
+    stub_request(:get, "http://#{$commentatr_host}/api/blogs/example.com/pages/1/comments.json").
+      to_return(status: 500, body: "bad response")
+    commentatr = Commentatr::Client.new
+    commentatr.comments(partner_host: "example.com", page_id: "1")
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+# SimpleCov
+require "simplecov"
+SimpleCov.start
+
+# App
+require "commentatr"
+
+# Webmock
+require "webmock/rspec"
+require "webmock"
+include WebMock::API
+WebMock.disable_net_connect!
+$commentatr_host = "#{Commentatr::Request::HOST}:#{Commentatr::Request::PORT}"
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: commentatr
+version: !ruby/object:Gem::Version
+  version: '0.1'
+  prerelease: 
+platform: ruby
+authors:
+- Gregory Eremin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-04 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: 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: simplecov
+  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: awesome_print
+  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'
+description: Ruby wrapper for Commentatr API
+email:
+- magnolia_fan@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- commentatr.gemspec
+- lib/commentatr.rb
+- lib/commentatr/client.rb
+- lib/commentatr/request.rb
+- lib/commentatr/response.rb
+- lib/commentatr/routes.rb
+- lib/commentatr/version.rb
+- spec/requests/comments_spec.rb
+- spec/spec_helper.rb
+homepage: http://commentatr.net/developer/gem
+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.23
+signing_key: 
+specification_version: 3
+summary: Gem provides easy access to Commentatr API web service
+test_files:
+- spec/requests/comments_spec.rb
+- spec/spec_helper.rb