ratings_aggregator 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7c2ca9cc0a9671068a69db61578c0943cd499b55
+  data.tar.gz: 66fd58914adfc56b6d21f1a58c947b1e3d94b009
+SHA512:
+  metadata.gz: 70c7deb4618c270b4229437a4b7dac132b7b1177c564b98ec9db64fb72a5994081db996c213fd16be152af64c46aebab715f584bc93d01cceead9bb3f79619b9
+  data.tar.gz: 166844d28e9908181bfdcf637ff535e6af8b237bbcba43f500378d4d8aaf8f8e039bae3df3977a6b72244f654973a198091ea05bcc65ee3cd68776ec4e28a291

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.2
+before_install: gem install bundler -v 1.16.0

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in ratings_aggregator.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,40 @@
+PATH
+  remote: .
+  specs:
+    ratings_aggregator (0.0.1)
+      json
+      rest-client
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    domain_name (0.5.20170404)
+      unf (>= 0.0.5, < 1.0.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    json (2.1.0)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    minitest (5.11.3)
+    netrc (0.11.0)
+    rake (10.5.0)
+    rest-client (2.0.2)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  minitest (~> 5.0)
+  rake (~> 10.0)
+  ratings_aggregator!
+
+BUNDLED WITH
+   1.16.0

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 William Lu
+
+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,23 @@
+# ratings_aggregator
+A ruby gem that aggregates the rating of a movie via OMDB
+
+## Installation
+
+$ gem build ratings_aggregator.gemspec
+
+$ [sudo] install ./ratings_aggregator-[VERSION].gem
+
+## Usage
+
+[You must get your own OMDB key to use this gem](http://www.omdbapi.com/)
+
+### Create a new aggregator object
+`aggregator = RatingsAggregator::Base.new`
+
+### Give it a valid OMDB key 
+`aggregator.set_key('YOUR_KEY')`
+
+### Get the aggregated score of a rating
+`aggregator.search('MOVIE_TITLE')`
+
+Note that if your search query returns multiple results, you will only get the data of the first movie in the query.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ratings_aggregator"
+
+# 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(__FILE__)

data/bin/ratings_aggregator

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+begin
+  require 'ratings_aggregator'
+rescue LoadError
+  require 'rubygems'
+  require 'ratings_aggregator'
+end

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/lib/ratings_aggregator/api.rb

@@ -0,0 +1,19 @@
+require 'net/http'
+require 'json'
+require 'rest-client'
+require_relative 'base'
+
+module RatingsAggregator
+  class Api
+    API_URL = "http://www.omdbapi.com/"
+
+    attr_accessor :response
+    def call(params)
+      response = RestClient.get API_URL, params: params
+        {
+          code: response.code,
+          data: JSON.parse(response.body)
+        }
+    end
+  end
+end

data/lib/ratings_aggregator/base.rb

@@ -0,0 +1,35 @@
+require 'net/http'
+require 'json'
+require_relative 'api'
+
+module RatingsAggregator
+  class Base
+    def search(search_title)
+      response = api.call(t: search_title, apikey: @key)
+      # puts response
+      if response[:data]["Response"] == "False"
+        nil
+      else
+        # pulls out the strings that represent the rating scores
+        rating_scores = response[:data]["Ratings"].map {|x| x["Value"]}
+
+        sum = 0.0
+        rating_scores.each do |score|
+          to_add = score.to_f
+          if /.+\/10$/.match score
+            to_add *= 10
+          end
+          sum += to_add
+        end
+        aggregate_score = (sum/rating_scores.length).round
+      end
+    end
+    def api
+      @api ||= RatingsAggregator::Api.new
+    end
+
+    def set_key(key)
+      @key = key
+    end
+  end
+end

data/lib/ratings_aggregator/version.rb

@@ -0,0 +1,3 @@
+module RatingsAggregator
+  VERSION = "0.0.1"
+end

data/lib/ratings_aggregator.rb

@@ -0,0 +1,6 @@
+require "ratings_aggregator/version"
+require "ratings_aggregator/base"
+require "ratings_aggregator/api"
+
+module RatingsAggregator
+end

data/ratings_aggregator.gemspec

@@ -0,0 +1,36 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ratings_aggregator/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ratings_aggregator"
+  spec.version       = RatingsAggregator::VERSION
+  spec.authors       = ["William Lu"]
+  spec.email         = ["william.lu@shopify.com"]
+
+  spec.summary       = %q{Provides an aggregate rating for a given movie}
+  spec.description   = %q{Searches for a movie using OMDB, then computes an aggregate critic rating for it. Users must provide their own key}
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+
+  spec.add_dependency "json"
+  spec.add_dependency "rest-client"
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: ratings_aggregator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- William Lu
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-03-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: json
+  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: rest-client
+  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'
+description: Searches for a movie using OMDB, then computes an aggregate critic rating
+  for it. Users must provide their own key
+email:
+- william.lu@shopify.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/ratings_aggregator
+- bin/setup
+- lib/ratings_aggregator.rb
+- lib/ratings_aggregator/api.rb
+- lib/ratings_aggregator/base.rb
+- lib/ratings_aggregator/version.rb
+- ratings_aggregator.gemspec
+homepage: 
+licenses: []
+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.2
+signing_key: 
+specification_version: 4
+summary: Provides an aggregate rating for a given movie
+test_files: []