simple_themoviedb 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf12e1f85c9a12ccf3ee97f8975890ac44b309fc495a423522768202f8f4e8df
-  data.tar.gz: 868c4ec54420f6023552b982ca0380644b5d498009b35250160e78ac5fc9633d
+  metadata.gz: 2366ccb8f61c3ea9b48bff67e2783b14370e0051254de0ea08453927b76c7777
+  data.tar.gz: f1198a2e823502c80d57b23515bc3988df1e9401731580d0f59e967d205cf1ef
 SHA512:
-  metadata.gz: 5603ee05feb92153dd39272f1a17f72b6475ceb0f3723075f6148c1eaf38ac45298e3b57bcc14956d7acde64a916b92795fb2ac3471a98687775637b2f7520df
-  data.tar.gz: aa773e43b2973646049b8f6abc52ab6860c5b5614d447d450412f403770d77662f865a1ad63161244eb20efee56c7ad3798b660ae5109a19c90bece3078a5ddf
+  metadata.gz: 9dc6eb2fa0aeae0cea1c3759782cb9103c0cf49116d4f2def86869d567832148d1b1da03f4a225350ba683b0bc62143e40de3c5ec15a6a2ae921fb400d030c87
+  data.tar.gz: a8123125c5bca0d5f30a93aed63f3306086196e3e9d8eeb5c03de6179fc53e40312e60b0aa9ac1f3e05f49902f30f8b2d5b1a0d0643eb80a8cdbac43c57501cf

data/Gemfile

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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    simple_themoviedb (0.1.1)
+    simple_themoviedb (0.2.0)
       httparty
 
 GEM

data/README.md

@@ -18,7 +18,56 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+First of all, initialize a client:
+
+```ruby
+@client = SimpleTheMovieDB::Client.new('your-api-key')
+```
+
+The SimpleTheMovieDB::Client has a few methods at your disposal:
+
+- #search
+
+Accepts one string (the query) as parameter. Returns an Array of Hashes. Each Hash contains a summarized version of the movie data.
+
+```ruby
+@client.search('The Wolf of Wall Street')
+ => [{"vote_count"=>8895, "id"=>106646, "video"=>false, "vote_average"=>7.9, "title"=>"The Wolf of Wall Street", "popularity"=>36.903397, "poster_path"=>"/vK1o5rZGqxyovfIhZyMELhk03wO.jpg", "original_language"=>"en", "original_title"=>"The Wolf of Wall Street", "genre_ids"=>[80, 18, 35], "backdrop_path"=>"/rP36Rx5RQh0rmH2ynEIaG8DxbV2.jpg", "adult"=>false, "overview"=>"A New York stockbroker refuses to cooperate in a large securities fraud case involving corruption on Wall Street, corporate banking world and mob infiltration. Based on Jordan Belfort's autobiography.", "release_date"=>"2013-12-25"}, {"vote_count"=>0, "id"=>423766, "video"=>false, "vote_average"=>0, "title"=>"The Wolf of Wall Street", "popularity"=>1.00119, "poster_path"=>"/aNGsE1nVtQHu4pvPzNvqVaczztb.jpg", "original_language"=>"en", "original_title"=>"The Wolf of Wall Street", "genre_ids"=>[], "backdrop_path"=>nil, "adult"=>false, "overview"=>"A ruthless stockbroker sells short in the copper business and ruins the life of his friends by ruining their finances.", "release_date"=>"1929-02-09"}] 
+```
+
+- #get_movie
+
+Accepts one integer (the ID) as parameter. Returns the full data for the given movie.
+
+```ruby
+@client.get_movie(106646)
+ => {"adult"=>false, "backdrop_path"=>"/rP36Rx5RQh0rmH2ynEIaG8DxbV2.jpg", "belongs_to_collection"=>nil, "budget"=>100000000, "genres"=>[{"id"=>80, "name"=>"Crime"}, {"id"=>18, "name"=>"Drama"}, {"id"=>35, "name"=>"Comedy"}], "homepage"=>"http://www.thewolfofwallstreet.com/", "id"=>106646, "imdb_id"=>"tt0993846", "original_language"=>"en", "original_title"=>"The Wolf of Wall Street", "overview"=>"A New York stockbroker refuses to cooperate in a large securities fraud case involving corruption on Wall Street, corporate banking world and mob infiltration. Based on Jordan Belfort's autobiography.", "popularity"=>35.903397, "poster_path"=>"/vK1o5rZGqxyovfIhZyMELhk03wO.jpg", "production_companies"=>[{"id"=>14654, "logo_path"=>nil, "name"=>"EMJAG Productions", "origin_country"=>""}, {"id"=>4, "logo_path"=>"/fycMZt242LVjagMByZOLUGbCvv3.png", "name"=>"Paramount", "origin_country"=>"US"}, {"id"=>19177, "logo_path"=>nil, "name"=>"Red Granite Pictures", "origin_country"=>""}, {"id"=>562, "logo_path"=>"/k3NsSdV854UX4zEReX1dl1Psxbb.png", "name"=>"Appian Way", "origin_country"=>"US"}, {"id"=>23243, "logo_path"=>nil, "name"=>"Sikelia Productions", "origin_country"=>""}], "production_countries"=>[{"iso_3166_1"=>"US", "name"=>"United States of America"}], "release_date"=>"2013-12-25", "revenue"=>392000694, "runtime"=>180, "spoken_languages"=>[{"iso_639_1"=>"fr", "name"=>"Français"}, {"iso_639_1"=>"en", "name"=>"English"}], "status"=>"Released", "tagline"=>"EARN. SPEND. PARTY.", "title"=>"The Wolf of Wall Street", "video"=>false, "vote_average"=>7.9, "vote_count"=>8898} 
+2.5.1 :031 
+```
+
+- #get_images
+
+Accepts one integer (the movie ID) as parameter. Returns an Array of Hashes with information on the images The MovieDatabase has of that particular movie.
+
+- #get_cast
+
+Accepts one integer (the movie ID) as parameter. Returns a Hash with three keys: id, cast and crew. ID is self-explanatory. Cast and crew are array of hashes with information on each member of the cast and the crew of the movie
+
+- #get_person
+
+Accepts one integer (the person ID) as parameter. Returns the full data for the given person.
+
+- #get_person_images
+
+Accepts one integer (the person ID) as parameter. Returns an Array of Hashes with information on the images The MovieDatabase has of that particular person.
+
+- #get_person_credits
+
+Accepts one integer (the person ID) as parameter. Returns a Hash with three keys: id, cast and crew. ID is self-explanatory. Cast and crew are array of hashes with information on the roles taken by this particular person in all of his movies, as an actor or as a crew-member.
+
+- #get_configuration
+
+Accepts no parameters. Returns information about the parameters accepted by The Movie Database.
 
 ## Development
 

data/Rakefile

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

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "simple_themoviedb"
+require 'bundler/setup'
+require 'simple_themoviedb'
 
 # 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.
@@ -10,5 +10,5 @@ require "simple_themoviedb"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/lib/simple_themoviedb/version.rb

@@ -1,3 +1,3 @@
 module SimpleTheMovieDB
-  VERSION = "0.1.1"
+  VERSION = '0.2.0'.freeze
 end

data/lib/simple_themoviedb.rb

@@ -1,46 +1,42 @@
-require "simple_themoviedb/version"
-require "httparty"
+require 'simple_themoviedb/version'
+require 'httparty'
 
 module SimpleTheMovieDB
   class Client
-    attr_reader :base, :api_key
+    attr_reader :api_key
 
-    include HTTParty
-    base_uri "http://api.themoviedb.org/3"
-    headers 'accept' => 'application/json' 
-    format :json
+    BASE_URL = 'http://api.themoviedb.org/3'.freeze
 
     def initialize(api_key)
       @api_key = api_key
     end
 
     def search(title, adult = nil)
-      url = "/search/movie?"
-      options = { :query => title, :api_key => @api_key }
-      options = options.merge( :include_adult => adult ) if adult
-
-      response = self.class.get(url + options.to_query)
-      parsed_response = response.parsed_response
-      total_pages = parsed_response["total_pages"]
-
-      if total_pages && total_pages.is_a?(Integer)
-        (2..total_pages).inject(parsed_response["results"]) do |res, page|
-          options[:page] = page
-          page_results = self.class.get(url + options.to_query).parsed_response["results"] || []
-          res + page_results
-        end
+      url = '/search/movie?'
+      options = { query: title, api_key: @api_key }
+      options = options.merge(include_adult: adult) if adult
+
+      response = get_and_parse(url, options)
+      total_pages = response['total_pages']
+
+      return unless total_pages && total_pages.is_a?(Integer)
+
+      (2..total_pages).inject(response['results']) do |res, page|
+        options[:page] = page
+        page_results = get_and_parse(url, options)['results'] || []
+        res + page_results
       end
     end
 
     def get_configuration
-      url = "/configuration?"
+      url = '/configuration?'
       get_and_parse(url)
     end
 
     def get_movie(id, lang = nil)
       url = "/movie/#{id}?"
-      options = { :api_key => @api_key }
-      options = options.merge(:language => lang) if lang
+      options = { api_key: @api_key }
+      options = options.merge(language: lang) if lang
       get_and_parse(url, options)
     end
 
@@ -72,13 +68,19 @@ module SimpleTheMovieDB
     private
 
     def get_and_parse(url, options = { api_key: @api_key })
-      self.class.get(url + to_query(options)).parsed_response
+      response = HTTParty.get(
+        BASE_URL + url + to_query(options),
+        headers: { 'accept' => 'applcation/json' },
+        format: :json
+      )
+
+      response.parsed_response
     end
 
     def to_query(options)
       options.map do |key, value|
         "#{key}=#{value}"
-      end.join("&")
+      end.join('&')
     end
   end
 end

data/simple_themoviedb.gemspec

@@ -1,38 +1,38 @@
 
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "simple_themoviedb/version"
+require 'simple_themoviedb/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "simple_themoviedb"
+  spec.name          = 'simple_themoviedb'
   spec.version       = SimpleTheMovieDB::VERSION
-  spec.authors       = ["Gawyn"]
-  spec.email         = ["me@cristianplanas.com"]
+  spec.authors       = ['Gawyn']
+  spec.email         = ['me@cristianplanas.com']
 
-  spec.summary       = "A simple wrapper on the TheMovieDB API"
-  spec.description   = "A simple wrapper on the TheMovieDB API"
-  spec.homepage      = "https://github.com/Gawyn/simple_themoviedb"
-  spec.license       = "MIT"
+  spec.summary       = 'A simple wrapper on the TheMovieDB API'
+  spec.description   = 'A simple wrapper on the TheMovieDB API'
+  spec.homepage      = 'https://github.com/Gawyn/simple_themoviedb'
+  spec.license       = 'MIT'
 
   # 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"] = "https://rubygems.org"
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
   else
-    raise "RubyGems 2.0 or newer is required to protect against " \
-      "public gem pushes."
+    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|
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_dependency "httparty"
+  spec.add_dependency 'httparty'
 
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple_themoviedb
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Gawyn