reviews_catcher 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6f4b47ea90bf150d41c52e9386000037ec554fd5
+  data.tar.gz: 5c1d642799381206437218a8b9925401cb39e74f
+SHA512:
+  metadata.gz: 5b64ca263172e1afdd5503b4cd1dead8057d3a5db19ff605a8aa5e44bb85702e6ad3c69992cdfefedcec08c854e440c7ca5cba5894147d0d29ec55530ff29264
+  data.tar.gz: 51fd80eefc31ebfb5b431b69a8fee16dbd64ba81eb6dfda795881fe384564da9a8b523d89ee3f8aafb1c7c16e32c933213aca511a36df0188dda513e236195a4

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+cache: bundler
+
+rvm:
+  - 2.3.0
+
+script: 'bundle exec rake'
+before_install: gem install bundler -v 1.11.2
+
+notifications:
+  email:
+    recipients:
+      - bruno@reviewscatcher.io
+    on_failure: change
+    on_success: never

data/Gemfile

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

data/MIT-LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Reviews Catcher (http://www.reviewscatcher.io)
+
+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,38 @@
+# reviewscatcher-ruby
+
+Ruby bindings for the Reviews Catcher API.
+
+## Instalation
+
+```ruby
+gem install reviews_catcher
+```
+
+Using bundler:
+
+```ruby
+gem 'reviews_catcher'
+```
+
+## Configure your client
+
+```
+reviews_catcher = ReviewsCatcher::Client.new(app_id: 'my_app_id', api_key: 'my_api_key')
+```
+
+You can get your `app_id` and `api_key` from your account in Reviews Catcher, in the integration settings page.
+
+## Usage
+
+```ruby
+# Find your account's aggregate rating
+aggregate_rating = reviews_catcher.account.aggregate_rating
+
+# Find your account's reviews
+reviews = reviews_catcher.reviews.all
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "reviews_catcher"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/changes.txt

@@ -0,0 +1,5 @@
+0.0.1
+ - initial version
+ - updated repo url in gemspec
+ - configured travis
+ - configured coveralls

data/lib/reviews_catcher/account.rb

@@ -0,0 +1,22 @@
+module ReviewsCatcher
+  class Account < BaseService
+
+    def name
+      response = JSON.parse(get_api_rating.body)
+
+      response['account_name']
+    end
+
+    def aggregate_rating
+      response = JSON.parse(get_api_rating.body)
+
+      response['aggregate_rating']
+    end
+
+    def rating_count
+      response = JSON.parse(get_api_rating.body)
+
+      response['rating_count']
+    end
+  end
+end

data/lib/reviews_catcher/base_service.rb

@@ -0,0 +1,55 @@
+require 'net/http'
+require 'uri'
+require 'json'
+
+module ReviewsCatcher
+  class InvalidApiRequestError < StandardError; end
+  class BaseService
+    attr_reader :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    def uri(action)
+      URI.parse(@client.base_url + action)
+    end
+
+    def authorization_header_value
+      "api_key=#{@client.api_key}"
+    end
+
+    def get(action)
+      uri = self.uri(action)
+
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.open_timeout = 3 # in seconds
+      http.read_timeout = 3 # in seconds
+
+      request = Net::HTTP::Get.new(uri.request_uri)
+      request['Authorization'] = authorization_header_value
+
+      http.request(request)
+    end
+
+    def get_api_rating
+      response = get('/api/v1/rating')
+
+      if response.code == '200'
+        response
+      else
+        fail InvalidApiRequestError.new("invalid response from API (CODE: #{response.code})")
+      end
+    end
+
+    def get_api_reviews
+      response = get('/api/v1/reviews')
+
+      if response.code == '200'
+        response
+      else
+        fail InvalidApiRequestError.new("invalid response from API (CODE: #{response.code})")
+      end
+    end
+  end
+end

data/lib/reviews_catcher/client.rb

@@ -0,0 +1,34 @@
+module ReviewsCatcher
+  class MisconfiguredClientError < StandardError; end
+  class Client
+    attr_reader :base_url, :app_id, :api_key
+
+    def initialize(app_id: 'my_app_id', api_key: 'my_api_key')
+      @app_id = app_id
+      @api_key = api_key
+
+      validate_credentials!
+
+      @base_url = build_base_url
+    end
+
+    def account
+      @account ||= ReviewsCatcher::Account.new(self)
+    end
+
+    def reviews
+      @reviews ||= ReviewsCatcher::Reviews.new(self)
+    end
+
+    private
+
+      def validate_credentials!
+        error = MisconfiguredClientError.new('app_id and api_key must not be nil')
+        fail error if @app_id.nil? || @api_key.nil?
+      end
+
+      def build_base_url
+        "http://#{@app_id}.reviewscatcher.io"
+      end
+  end
+end

data/lib/reviews_catcher/reviews.rb

@@ -0,0 +1,28 @@
+module ReviewsCatcher
+  class Reviews < BaseService
+
+    def name
+      response = JSON.parse(get_api_reviews.body)
+
+      response['account_name']
+    end
+
+    def aggregate_rating
+      response = JSON.parse(get_api_reviews.body)
+
+      response['aggregate_rating']
+    end
+
+    def rating_count
+      response = JSON.parse(get_api_reviews.body)
+
+      response['rating_count']
+    end
+
+    def all
+      response = JSON.parse(get_api_reviews.body)
+
+      response['reviews']
+    end
+  end
+end

data/lib/reviews_catcher/version.rb

@@ -0,0 +1,3 @@
+module ReviewsCatcher
+  VERSION = '0.0.1'
+end

data/lib/reviews_catcher.rb

@@ -0,0 +1,10 @@
+require 'reviews_catcher/version'
+
+require 'reviews_catcher/base_service'
+
+require 'reviews_catcher/account'
+require 'reviews_catcher/client'
+require 'reviews_catcher/reviews'
+
+module ReviewsCatcher
+end

data/reviews_catcher.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'reviews_catcher/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'reviews_catcher'
+  spec.version       = ReviewsCatcher::VERSION
+  spec.authors       = ['Bruno Valentino']
+  spec.email         = ['brunovalentino@gmail.com']
+
+  spec.summary       = %q{Ruby bindings for the ReviewsCatcher API (http://wwww.reviewscatcher.io)}
+  spec.description   = %q{Ruby bindings for the ReviewsCatcher API (http://wwww.reviewscatcher.io)}
+  spec.homepage      = 'https://github.com/reviewscatcher/reviewscatcher-ruby'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'forgery'
+  spec.add_development_dependency 'coveralls'
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: reviews_catcher
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Bruno Valentino
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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'
+- !ruby/object:Gem::Dependency
+  name: forgery
+  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'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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: Ruby bindings for the ReviewsCatcher API (http://wwww.reviewscatcher.io)
+email:
+- brunovalentino@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- MIT-LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- changes.txt
+- lib/reviews_catcher.rb
+- lib/reviews_catcher/account.rb
+- lib/reviews_catcher/base_service.rb
+- lib/reviews_catcher/client.rb
+- lib/reviews_catcher/reviews.rb
+- lib/reviews_catcher/version.rb
+- reviews_catcher.gemspec
+homepage: https://github.com/reviewscatcher/reviewscatcher-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Ruby bindings for the ReviewsCatcher API (http://wwww.reviewscatcher.io)
+test_files: []