Class: Tmdb

Inherits:
Object
  • Object
show all
Defined in:
lib/ruby-tmdb3/tmdb.rb

Constant Summary collapse

CONFIGURATION =

TODO: Should be refreshed and cached from API

DeepOpenStruct.load({ "images" =>
                  { 
                    "base_url"        => "http://cf2.imgobject.com/t/p/", 
                    "posters_sizes"   => ["w92", "w154", "w185", "w342", "w500", "original"],
                    "backdrops_sizes" => ["w300", "w780", "w1280", "original"],
                    "profiles_sizes"  => ["w45", "w185", "h632", "original"],
                    "logos_sizes"     => ["w45", "w92", "w154", "w185", "w300", "w500", "original"]
                  }
})
@@api_key = 
""
@@default_language = 
"en"
@@api_response = 
{}

Class Method Summary collapse

Class Method Details

.api_call(method, data, language = nil) ⇒ Object

Raises:

  • (ArgumentError) 


45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/ruby-tmdb3/tmdb.rb', line 45

def self.api_call(method, data, language = nil)
  raise ArgumentError, "Tmdb.api_key must be set before using the API" if(Tmdb.api_key.nil? || Tmdb.api_key.empty?)
  raise ArgumentError, "Invalid data." if(data.nil? || (data.class != Hash))

  method, action = method.split '/'

  data = {
    api_key:  Tmdb.api_key,
    language: language
  }.merge(data)

  # Addressable can only handle hashes whose values respond to to_str, so lets be nice and convert things.
  query_values = {}
  data.each do |key,value|
    if not value.respond_to?(:to_str) and value.respond_to?(:to_s)
      query_values[key] = value.to_s
    else
      query_values[key] = value
    end
  end

  uri = Addressable::URI.new

  # Construct URL for queries with id
  if data.has_key?(:id)
    uri.query_values = query_values
  # Construct URL other queries
  else
    query_values = {
      query: CGI::escape(data[:query])
    }.merge(query_values)
    uri.query_values = query_values
  end
  url            = [Tmdb.base_api_url, method, data[:id], action].compact.join '/'
  url_with_query = [url, uri.query].compact.join '?'
  
  response = Tmdb.get_url(url_with_query)
  if(response.code.to_i != 200)
    raise RuntimeError, "Tmdb API returned status code '#{response.code}' for URL: '#{url}'"
  end

  body = JSON(response.body)
  if body.has_key?("results") && body["results"].empty?
    return nil
  else
    return body
  end
end

.api_key ⇒ Object 



25
26
27
 
# File 'lib/ruby-tmdb3/tmdb.rb', line 25

def self.api_key
  @@api_key
end

.api_key=(key) ⇒ Object 



29
30
31
 
# File 'lib/ruby-tmdb3/tmdb.rb', line 29

def self.api_key=(key)
  @@api_key = key
end

.base_api_url ⇒ Object 



41
42
43
 
# File 'lib/ruby-tmdb3/tmdb.rb', line 41

def self.base_api_url
  "http://api.themoviedb.org/3"
end

.data_to_object(data) ⇒ Object 



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/ruby-tmdb3/tmdb.rb', line 111

def self.data_to_object(data)
  object          = DeepOpenStruct.load(data)
  object.raw_data = data
  ["posters", "backdrops"].each do |image_array_name|
    image_array = Array object.send(image_array_name)
    single_name = image_array_name.slice 0..-2 # singularize name
    single_path = object.send "#{single_name}_path" # default poster/backdrop image
    image_array << object.send("#{image_array_name.slice 0..-2}=", DeepOpenStruct.load({file_path: single_path}))
    # build a struct containing availables sizes with their urls
    image_array.each do |image|
      urls = CONFIGURATION.images.send("#{image_array_name}_sizes").inject({}) do |hash, size|
        hash[size] = {'url' => [CONFIGURATION.images.base_url, size, image.file_path].join}
        hash
      end
      image.sizes = DeepOpenStruct.load urls
    end
  end
  unless(object.cast.nil?)
    object.cast.each_index do |x|
      object.cast[x].instance_eval <<-EOD
        def self.bio
          return TmdbCast.find(:id => self.id, :limit => 1)
        end
      EOD
    end
  end
  return object
end

.default_language ⇒ Object 



33
34
35
 
# File 'lib/ruby-tmdb3/tmdb.rb', line 33

def self.default_language
  @@default_language
end

.default_language=(language) ⇒ Object 



37
38
39
 
# File 'lib/ruby-tmdb3/tmdb.rb', line 37

def self.default_language=(language)
  @@default_language = language
end

.get_url(uri_str, limit = 10) ⇒ Object

Get a URL and return a response object, follow upto ‘limit’ re-directs on the way



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/ruby-tmdb3/tmdb.rb', line 95

def self.get_url(uri_str, limit = 10)
  return false if limit == 0
  begin 
    response = Net::HTTP.get_response(URI.parse(uri_str))
  rescue SocketError, Errno::ENETDOWN
    response = Net::HTTPBadRequest.new( '404', 404, "Not Found" )
    return response
  end 
  case response
    when Net::HTTPSuccess     then response
    when Net::HTTPRedirection then get_url(response['location'], limit - 1)
  else
    Net::HTTPBadRequest.new( '404', 404, "Not Found" )
  end
end