omdb-api 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6a2c321db04cfe60d53a29f52e1224e9f12ced5652b36d625a4d2b89f8e1ffea
+  data.tar.gz: 586faa3491d686935bccd36a958656be6ecdd7f92a1f660ea384cb448baa665a
+SHA512:
+  metadata.gz: 9caec6e78e7b108c2843825ab48013f4a105b103d621238b72439cd597ecb4be701ac9513768ec9c7871cc08fd0f81f62e1866e81e7984615e6ab55bdf79d106
+  data.tar.gz: 28ed895fd0cee519bd33977513de95e6d5c400530b8a935eee53523f6c5fe15dabf8a6023e82460baed53ae7786b25942698fd8ca1e98a34307928327fdd6526

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,5 @@
+Metrics:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gem 'rake'
+
+group :development do
+  gem 'pry'
+end
+
+group :test do
+  gem 'rspec'
+  gem 'rubocop'
+  gem 'webmock'
+end
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Nick Palaniuk
+
+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,110 @@
+# Omdb Api
+
+[![Build Status](https://travis-ci.org/nikkypx/omdb-api.svg?branch=master)](https://travis-ci.org/nikkypx/omdb-api)
+
+> A ruby interface for the [Open Movie Database API](http://omdbapi.com/)
+
+## Required
+
+You must request an API key first from [here](http://omdbapi.com/)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'omdb-api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install omdb-api
+
+## Usage
+
+First you have to create a client object with your API key
+
+`client = Omdb::Api::Client.new(api_key: [your API key])`
+
+Then you can query with this client object
+
+```ruby
+require 'omdb/api'
+
+client.find_by_title('star wars')
+=> #<Omdb::Api::Movie:0x007f9a7d453cf0 @actors="Harrison Ford"...
+
+client.find_by_id('tt0083929')
+=> #<Omdb::Api::Movie:0x007f960a648f28 @actors="Sean Penn, Jennifer Jason Leigh, Judge Reinhold, Robert Romanus",
+
+client.search('indiana jones')
+=> [#<Omdb::Api::Movie:0x007ffec28ad1a8 @title="Indiana...
+```
+
+You can also pass options to these methods that match the available options from 
+the OMDB API spec.
+
+For example:
+
+`client.find_by_title('star wars', plot: 'short')`
+
+Returns an `Omdb::Api::Movie`
+
+`#find_by_id('id')`
+
+`#find_by_title('title')`
+
+Returns an `Omdb::Api::Collection`
+
+`#search('movie')`
+
+An unsuccessful query will return an `Omdb::Api::Error` object
+
+
+An `Omdb::Api::Movie` object has
+
+```ruby
+#actors
+#awards
+#country
+#director
+#genre
+#imdbid
+#imdbrating
+#imdbvotes
+#language
+#metascore
+#plot
+#poster
+#rated
+#released
+#response
+#runtime
+#title
+#type
+#writer
+#year
+```
+
+An `Omdb::Api::Error` object has
+
+```ruby
+#response
+#error
+```
+
+## Development
+
+`$ rake` to run the specs
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/nikkypx/omdb-api.
+
+## 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,10 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+RSpec::Core::RakeTask.new(:spec)
+
+task default: %i[rubocop spec]

data/lib/omdb/api.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'omdb/api/version'
+require 'omdb/api/collection'
+require 'omdb/api/movie'
+require 'omdb/api/public_api'
+require 'omdb/api/client'
+require 'omdb/api/request'
+require 'omdb/api/error'
+require 'httparty'

data/lib/omdb/api/client.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Omdb
+  module Api
+    class Client
+      include PublicApi
+
+      attr_accessor :api_key
+
+      def initialize(options = {})
+        options.each_pair do |k, v|
+          instance_variable_set("@#{k}", v)
+        end
+        yield(self) if block_given?
+      end
+    end
+  end
+end

data/lib/omdb/api/collection.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Omdb
+  module Api
+    class Collection
+      include Enumerable
+      attr_accessor :movies
+
+      def initialize(movies)
+        self.movies = Array.new(movies)
+      end
+
+      def each
+        movies.each { |item| yield item }
+      end
+    end
+  end
+end

data/lib/omdb/api/error.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Omdb
+  module Api
+    class Error
+      ERROR_ATTRIBUTES = %i[
+        response
+        error
+      ].freeze
+
+      attr_reader(*ERROR_ATTRIBUTES)
+
+      def initialize(response)
+        attrs(response)
+      end
+
+      def attrs(response)
+        response.each_key do |key|
+          instance_variable_set("@#{key.downcase}".to_sym, response[key])
+        end
+      end
+    end
+  end
+end

data/lib/omdb/api/movie.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Omdb
+  module Api
+    class Movie
+      MOVIE_ATTRIBUTES = %i[
+        actors
+        awards
+        country
+        director
+        genre
+        imdbid
+        imdbrating
+        imdbvotes
+        language
+        metascore
+        plot
+        poster
+        rated
+        released
+        runtime
+        title
+        type
+        writer
+        year
+        error
+      ].freeze
+
+      attr_reader(*MOVIE_ATTRIBUTES)
+
+      def initialize(response)
+        attrs(response)
+      end
+
+      def attrs(response)
+        response.each_key do |key|
+          instance_variable_set("@#{key.downcase}".to_sym, response[key])
+        end
+      end
+    end
+  end
+end

data/lib/omdb/api/public_api.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Omdb
+  module Api
+    module PublicApi
+      %i[find_by_id find_by_title search].each do |method|
+        define_method(method) do |value, **options|
+          request = Omdb::Api::Request.new(api_key, method, value, options)
+
+          if method == :search && request.success?
+            movies = [].tap do |m|
+              request.response.fetch('Search').each do |movie|
+                m << Omdb::Api::Movie.new(movie)
+              end
+            end
+            Omdb::Api::Collection.new(movies)
+          elsif request.success?
+            Omdb::Api::Movie.new(request.response)
+          else
+            Omdb::Api::Error.new(request.response)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/omdb/api/request.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Omdb
+  module Api
+    class Request
+      BASE_URI = 'https://www.omdbapi.com'
+
+      attr_reader :api_key, :field, :value, :options
+
+      def initialize(api_key, method, value, options)
+        @api_key = api_key
+        @field   = if /id/.match?(method)
+                     'i'
+                   elsif /title/.match?(method)
+                     't'
+                   else
+                     's'
+                   end
+        @value   = CGI.escape(value)
+        @options = options
+      end
+
+      def query_params
+        { query: { apikey: api_key, field.to_s => value.to_s }.merge(options) }
+      end
+
+      def response
+        @response ||= HTTParty.get(BASE_URI, query_params)
+      end
+
+      def success?
+        (response['Response'] || response['root']['response']) == 'True'
+      end
+    end
+  end
+end

data/lib/omdb/api/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Omdb
+  module Api
+    VERSION = '1.0.0'
+  end
+end

data/omdb-api.gemspec

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'omdb/api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'omdb-api'
+  spec.version       = Omdb::Api::VERSION
+  spec.authors       = ['Nick Palaniuk']
+  spec.email         = ['npalaniuk@gmail.com']
+  spec.summary       = 'Ruby interface for the OMDB API'
+  spec.description   = 'A ruby interface for the OMDB API'
+  spec.homepage      = 'https://github.com/nikkypx/omdb-api'
+  spec.license       = 'MIT'
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.require_paths = ['lib']
+  spec.add_dependency 'httparty'
+  spec.add_development_dependency 'bundler'
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: omdb-api
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Nick Palaniuk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-08-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  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: bundler
+  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: A ruby interface for the OMDB API
+email:
+- npalaniuk@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/omdb/api.rb
+- lib/omdb/api/client.rb
+- lib/omdb/api/collection.rb
+- lib/omdb/api/error.rb
+- lib/omdb/api/movie.rb
+- lib/omdb/api/public_api.rb
+- lib/omdb/api/request.rb
+- lib/omdb/api/version.rb
+- omdb-api.gemspec
+homepage: https://github.com/nikkypx/omdb-api
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Ruby interface for the OMDB API
+test_files: []