omdb-api 1.4.3 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b434f90503d4999be549f1e24e40bccfb83c2e0d568838c9f6840e97ed60a80f
-  data.tar.gz: 6ebabe3d1e8048ca976d92a90d2733cf266bc4d6c83405ffaac0255f8807a053
+  metadata.gz: dc18a31e3a6e5ac9b7825783220ad5b8c05195150845a8042a54294528f4867a
+  data.tar.gz: c729c986aa822cd3fdfbea991d55154cc8709d73e250a2fb524086cafe1f739e
 SHA512:
-  metadata.gz: 2bc3aa06e4c30f98ab3659ed1e701134e063e8d713fb40c3c4e1e7e5e70626f6b3a6ba2343b1d74fe49044d2674772feab1c21e457ba43ba1f067d80fbf9bd6d
-  data.tar.gz: b3dfb55d02b3ec34adfd18fbb62878afa89fee38771a892e90eb1e89e4f09f24d088dc27316304c328cca2c6015ecc0cb6eb8488a2ab31d963d01e02d957f0de
+  metadata.gz: 846f21c9236f28a6d6415f7ba95825a4ee253f4d26f464c994cc7e0cee3fa86031af404167515f04a7c2def257d577a948139ded15c584da584ade2984f8bf3f
+  data.tar.gz: 001ae8d21322fa92ff346d9c08aa8025a2e4ce1bf19cbd4d268bcc7177764e56bcd79d17006bebe6dff014550d60e15021c677db67fb1188d8170fd3f295a130

data/CHANGELOG.md

@@ -0,0 +1,19 @@
+## 2.0 (2020-07-26)
+
+### Breaking Changes
+
+* query params given to the client will be full words
+and mapped to the Omdb API params - implemented so far:
+
+```ruby
+{
+  id: 'i',
+  title: 't',
+  search: 's',
+  plot: 'plot',
+  year: 'y',
+  version: 'v'
+}
+```
+
+* a collection is now called `Movies` and will return `MovieResult` objects

data/Gemfile

@@ -9,6 +9,7 @@ group :development do
 end
 
 group :test do
+  gem 'faker'
   gem 'rspec'
   gem 'rubocop'
   gem 'webmock'

data/README.md

@@ -6,7 +6,7 @@
 
 ## Required
 
-You must request an API key first from [here](http://omdbapi.com/)
+You must request an API key first from [here](http://omdbapi.com/apikey.aspx)
 
 ## Installation
 
@@ -30,7 +30,9 @@ Or install it yourself as:
 
 First you have to create a client object with your API key
 
-`client = Omdb::Api::Client.new(api_key: [your API key])`
+```ruby
+client = Omdb::Api::Client.new(api_key: [your API key])`
+```
 
 You can also set the API key with a block
 
@@ -60,19 +62,16 @@ 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')`
+```ruby
+client.find_by_title('star wars', plot: 'short')`
+```
 
-Returns an `Omdb::Api::Collection`
+Returns an `Omdb::Api::Types::Movie`
 
-`#search('movie')`
+An unsuccessful query will return an `Omdb::Api::Types::Error` object
 
-An unsuccessful query will return an `Omdb::Api::Error` object
+## TODO
+Implement all all find options
 
 
 ## API

data/lib/omdb/api.rb

@@ -1,12 +1,4 @@
 # 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 'active_support'
-require 'active_support/core_ext/string'
-require 'httparty'

data/lib/omdb/api/client.rb

@@ -1,18 +1,27 @@
 # frozen_string_literal: true
 
+require 'omdb/api/public_api'
+
 module Omdb
   module Api
     class Client
       include PublicApi
 
-      attr_accessor :api_key
+      attr_reader :configuration
 
       def initialize(options = {})
-        options.each_pair do |k, v|
-          instance_variable_set("@#{k}", v)
-        end
-        yield(self) if block_given?
+        @configuration = Configuration.new
+
+        options.each { |k, v| @configuration.__send__("#{k}=", v) }
+
+        yield(@configuration) if block_given?
       end
+
+      class Configuration
+        attr_accessor :api_key
+      end
+
+      private_constant :Configuration
     end
   end
 end

data/lib/omdb/api/public_api.rb

@@ -1,42 +1,17 @@
 # frozen_string_literal: true
 
+require 'omdb/api/request'
+require 'omdb/api/utils'
+require 'omdb/api/types'
+require 'omdb/api/public_api/find_by'
+require 'omdb/api/public_api/search'
+
 module Omdb
   module Api
     module PublicApi
-      %i[find_by_id find_by_title].each do |method|
-        define_method(method) do |value, **options|
-          Omdb::Api::Request.call(self, method, value, options) do |response|
-            response = format_response(response)
-            if response.dig('response') == 'False'
-              Omdb::Api::Error.new(response)
-            else
-              Omdb::Api::Movie.new(response)
-            end
-          end
-        end
-      end
-
-      def search(value, options = {})
-        Omdb::Api::Request.call(self, 'search', value, options) do |response|
-          begin
-            Omdb::Api::Collection.new(
-              response.fetch('Search').map do |movie_data|
-                response = format_response(movie_data)
-
-                Omdb::Api::Movie.new(response)
-              end
-            )
-          rescue StandardError
-            Omdb::Api::Error.new(response)
-          end
-        end
-      end
-
-      private
-
-      def format_response(response)
-        response.keys.map(&:underscore).zip(response.values).to_h
-      end
+      include Utils
+      include FindBy
+      include Search
     end
   end
 end

data/lib/omdb/api/public_api/find_by.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Omdb
+  module Api
+    module PublicApi
+      module FindBy
+        def find_by_id(id, **options)
+          perform_get(
+            klass: Omdb::Api::Types::Movie,
+            query_params: { id: id }.merge(options),
+            headers: options.fetch(:headers, {})
+          )
+        end
+
+        def find_by_title(title, **options)
+          perform_get(
+            klass: Omdb::Api::Types::Movie,
+            query_params: { title: title }.merge(options),
+            headers: options.fetch(:headers, {})
+          )
+        end
+      end
+    end
+  end
+end

data/lib/omdb/api/public_api/search.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Omdb
+  module Api
+    module PublicApi
+      module Search
+        def search(value, **options)
+          perform_get(
+            klass: Omdb::Api::Types::Movies,
+            query_params: { search: value }.merge(options),
+            headers: options.fetch(:headers, {})
+          )
+        end
+      end
+    end
+  end
+end

data/lib/omdb/api/request.rb

@@ -1,38 +1,60 @@
 # frozen_string_literal: true
 
+require 'httparty'
+
 module Omdb
   module Api
     class Request
       BASE_URI = 'https://www.omdbapi.com'
 
-      attr_reader :client, :field, :value, :options
+      def initialize(client, request_method, params)
+        @configuration = client.configuration
+        @request_method = request_method
+        @headers = _set_headers(params.delete(:headers))
+        @params = _set_params(params.delete(:query_params))
+      end
 
-      def self.call(client, method, value, options, &block)
-        new(client, method, value, options).make_get_to_imdb_api(&block)
+      def perform
+        _http_client.public_send(
+          @request_method,
+          BASE_URI,
+          headers: @headers,
+          query: @params
+        )
       end
 
-      def initialize(client, method, value, options)
-        @client  = client
-        @value   = CGI.escape(value)
-        @options = options
-        @field   = if /id/.match?(method)
-                     'i'
-                   elsif /title/.match?(method)
-                     't'
-                   else
-                     's'
-                   end
+      private
+
+      PARAMS_MAP = {
+        id: 'i',
+        title: 't',
+        search: 's',
+        plot: 'plot',
+        year: 'y',
+        return: 'r',
+        version: 'v'
+      }.freeze
+
+      def _set_params(params)
+        {}.tap do |p|
+          params.each { |k, v| p[PARAMS_MAP[k]] = v }
+        end.merge({ apikey: @configuration.api_key })
       end
 
-      def make_get_to_imdb_api
-        params = {
-          query: {
-            apikey: client.api_key,
-            field.to_s => value.to_s
-          }.merge(options)
+      def _set_headers(headers)
+        key_translate = {
+          content_type: 'Content-Type'
         }
 
-        yield HTTParty.get(BASE_URI, params)
+        translated_headers = headers.each_with_object({}) do |(k, v), o|
+          o[key_translate[k]] = v
+        end
+
+        { 'Content-Type' => 'application/json' }.merge(translated_headers)
+      end
+
+      def _http_client
+        HTTParty
       end
     end
   end

data/lib/omdb/api/types.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'dry-struct'
+require 'omdb/api/types/base'
+require 'omdb/api/types/movie'
+require 'omdb/api/types/movie_result'
+require 'omdb/api/types/movies'
+require 'omdb/api/types/error'

data/lib/omdb/api/types/base.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Omdb
+  module Api
+    module Types
+      class Base < Dry::Struct
+        transform_keys(&:to_sym)
+      end
+    end
+  end
+end

data/lib/omdb/api/types/error.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Omdb
+  module Api
+    module Types
+      include Dry.Types()
+
+      class Error < Base
+        attribute :response, Omdb::Api::Types::String.optional.default(nil)
+        attribute :error,    Omdb::Api::Types::String.optional.default(nil)
+      end
+    end
+  end
+end

data/lib/omdb/api/types/movie.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Omdb
+  module Api
+    module Types
+      include Dry.Types()
+
+      class Movie < Base
+        attribute :actors,      Omdb::Api::Types::String.optional.default(nil)
+        attribute :awards,      Omdb::Api::Types::String.optional.default(nil)
+        attribute :box_office,  Omdb::Api::Types::String.optional.default(nil)
+        attribute :country,     Omdb::Api::Types::String.optional.default(nil)
+        attribute :director,    Omdb::Api::Types::String.optional.default(nil)
+        attribute :dvd,         Omdb::Api::Types::String.optional.default(nil)
+        attribute :error,       Omdb::Api::Types::String.optional.default(nil)
+        attribute :genre,       Omdb::Api::Types::String.optional.default(nil)
+        attribute :imdb_id,     Omdb::Api::Types::String.optional.default(nil)
+        attribute :imdb_rating, Omdb::Api::Types::String.optional.default(nil)
+        attribute :imdb_votes,  Omdb::Api::Types::String.optional.default(nil)
+        attribute :language,    Omdb::Api::Types::String.optional.default(nil)
+        attribute :metascore,   Omdb::Api::Types::String.optional.default(nil)
+        attribute :plot,        Omdb::Api::Types::String.optional.default(nil)
+        attribute :poster,      Omdb::Api::Types::String.optional.default(nil)
+        attribute :rated,       Omdb::Api::Types::String.optional.default(nil)
+        attribute :released,    Omdb::Api::Types::String.optional.default(nil)
+        attribute :runtime,     Omdb::Api::Types::String.optional.default(nil)
+        attribute :title,       Omdb::Api::Types::String.optional.default(nil)
+        attribute :type,        Omdb::Api::Types::String.optional.default(nil)
+        attribute :writer,      Omdb::Api::Types::String.optional.default(nil)
+        attribute :year,        Omdb::Api::Types::String.optional.default(nil)
+      end
+    end
+  end
+end

data/lib/omdb/api/types/movie_result.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Omdb
+  module Api
+    module Types
+      include Dry.Types()
+
+      class MovieResult < Base
+        attribute :imdb_id, Omdb::Api::Types::String.optional.default(nil)
+        attribute :poster,  Omdb::Api::Types::String.optional.default(nil)
+        attribute :title,   Omdb::Api::Types::String.optional.default(nil)
+        attribute :type,    Omdb::Api::Types::String.optional.default(nil)
+        attribute :year,    Omdb::Api::Types::String.optional.default(nil)
+      end
+    end
+  end
+end

data/lib/omdb/api/types/movies.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Omdb
+  module Api
+    module Types
+      include Dry.Types()
+
+      class Movies < Base
+        attribute :search, Omdb::Api::Types::Strict::Array.of(Omdb::Api::Types::MovieResult).optional.default([])
+      end
+    end
+  end
+end

data/lib/omdb/api/utils.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'active_support/all'
+
+module Omdb
+  module Api
+    module Utils
+      def perform_get(options)
+        perform_request(:get, options)
+      end
+
+      def perform_request(request_method, options)
+        klass = options.delete(:klass)
+
+        _response_handler(klass) do
+          Omdb::Api::Request.new(self, request_method, options).perform
+        end
+      end
+
+      def _response_handler(klass)
+        _handle_response(yield, klass)
+        # rescue Errno::ECONNREFUSED => e
+      end
+
+      def _handle_response(resp, klass)
+        resp.deep_transform_keys! { |k| k.underscore.to_sym }
+
+        resp.fetch(:response) == 'True' ? klass.new(resp) : Omdb::Api::Types::Error.new(resp)
+      end
+    end
+  end
+end

data/lib/omdb/api/version.rb

@@ -2,6 +2,6 @@
 
 module Omdb
   module Api
-    VERSION = '1.4.3'
+    VERSION = '2.0.0'
   end
 end

data/omdb-api.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   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.description   = '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|
@@ -18,7 +18,8 @@ Gem::Specification.new do |spec|
   end
 
   spec.require_paths = ['lib']
-  spec.add_dependency 'activesupport'
-  spec.add_dependency 'httparty'
+  spec.add_dependency 'activesupport', '~> 4.2.10'
+  spec.add_dependency 'dry-struct', '~> 1.3'
+  spec.add_dependency 'httparty', '~> 0.15'
   spec.add_development_dependency 'bundler'
 end

metadata

@@ -1,43 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: omdb-api
 version: !ruby/object:Gem::Version
-  version: 1.4.3
+  version: 2.0.0
 platform: ruby
 authors:
 - Nick Palaniuk
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-04-25 00:00:00.000000000 Z
+date: 2020-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.2.10
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.2.10
+- !ruby/object:Gem::Dependency
+  name: dry-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.15'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.15'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -52,7 +66,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: A ruby interface for the OMDB API
+description: Ruby interface for the OMDB API
 email:
 - npalaniuk@gmail.com
 executables: []
@@ -63,24 +77,31 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - 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/public_api/find_by.rb
+- lib/omdb/api/public_api/search.rb
 - lib/omdb/api/request.rb
+- lib/omdb/api/types.rb
+- lib/omdb/api/types/base.rb
+- lib/omdb/api/types/error.rb
+- lib/omdb/api/types/movie.rb
+- lib/omdb/api/types/movie_result.rb
+- lib/omdb/api/types/movies.rb
+- lib/omdb/api/utils.rb
 - lib/omdb/api/version.rb
 - omdb-api.gemspec
 homepage: https://github.com/nikkypx/omdb-api
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -96,7 +117,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Ruby interface for the OMDB API
 test_files: []

data/lib/omdb/api/collection.rb

@@ -1,18 +0,0 @@
-# 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

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-module Omdb
-  module Api
-    class Error
-      attr_reader :response,
-                  :error
-
-      def initialize(params)
-        params.each_pair do |k, v|
-          instance_variable_set("@#{k}", v)
-        end
-      end
-    end
-  end
-end

data/lib/omdb/api/movie.rb

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-module Omdb
-  module Api
-    class Movie
-      attr_reader :actors,
-                  :awards,
-                  :box_office,
-                  :country,
-                  :director,
-                  :dvd,
-                  :error,
-                  :genre,
-                  :imdb_id,
-                  :imdb_rating,
-                  :imdb_votes,
-                  :language,
-                  :metascore,
-                  :plot,
-                  :poster,
-                  :rated,
-                  :released,
-                  :runtime,
-                  :title,
-                  :type,
-                  :writer,
-                  :year
-
-      def initialize(params)
-        params.each_pair do |k, v|
-          instance_variable_set("@#{k}", v)
-        end
-      end
-    end
-  end
-end