gracenote 1.0.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9f7545f432cea511b488d6ea632200ec5a775eaf
-  data.tar.gz: 5b0957e4b9a669bcabafaab628c84742f021a424
+  metadata.gz: 5d4bdc1ae286f082a3230f516c9750a09a010ed2
+  data.tar.gz: e921c97c0b4946b1487e7c1c1e05db37ec535674
 SHA512:
-  metadata.gz: ee0cc2b2186097c6ff6f80f2ce67a2bc14777ca19ab37e271578e35a126a1df9c5bcfea47b97030d7aaa9c225b50a9734e0370659f63751d4d31ce98bb77b93a
-  data.tar.gz: e205b23194913789b75a5cfbeca4be023a3ef0e28c9790ae924b56fb82ab12a42fa9cdadc1c7d62e8c7cb445c86f124bdfd287df14573b7499eabca4413c1737
+  metadata.gz: d6b4e28f592b05afa5441469288ea7e0a606d7bc882ba2f0a1c9cb646060032a185003cb067c07296430b0c73e36d64b09fa5527eba0e306de6fd6efce9fd7d7
+  data.tar.gz: b2d9b321bb97a238a5e7b94a752b7dac1ebde804df27dcf34cf638d8e0fd08deb5cec6c4c1938fcf4528a555df04859c03f0e99277f91ed0c582de36bfa072a5

data/lib/gracenote.rb

@@ -48,7 +48,7 @@ class Gracenote
                 <CLIENT>"+ clientID +"</CLIENT>
               </QUERY>
             </QUERIES>"
-    resp = HTTP.post(@apiURL, data)
+    resp = api(data)
     resp = checkRES resp
     @userID = resp['RESPONSES']['RESPONSE']['USER']
 
@@ -66,9 +66,9 @@ class Gracenote
     if @userID == nil 
       registerUser
     end
-    body = constructQueryBody(artistName, albumTitle, trackTitle, "", "ALBUM_SEARCH", matchMode)
-    data = constructQueryReq(body)
-    return api(data);
+    body = constructAlbumQueryBody(artistName, albumTitle, trackTitle, "", "ALBUM_SEARCH", matchMode)
+    data = api(constructQueryReq(body))
+    return parseAlbumRES(data);
   end
   
   # Function: findArtist 
@@ -100,8 +100,8 @@ class Gracenote
       registerUser
     end
     body = "<TOC><OFFSETS>" + toc + "</OFFSETS></TOC>"
-    data = constructQueryBody(body, "ALBUM_TOC")
-    return api(data)
+    data = constructAlbumQueryBody(body, "ALBUM_TOC")
+    return parseAlbumRES(data)
   end
 
   # Function: fetchOETData
@@ -124,7 +124,7 @@ class Gracenote
               </OPTION>"
 
     data = constructQueryReq(body, "ALBUM_FETCH")
-    resp = HTTP.post(@apiURL, data)
+    resp = api(data)
     resp = checkRES resp
     
     json = resp["RESPONSES"]
@@ -136,15 +136,121 @@ class Gracenote
     return output
   end
   
-  # protected methods
+  # TVShow methods
+
+  # Function: fetchSeason
+  # Fetches details of a season from gn_id
+  # Arguments:
+  #   gn_id
+  def fetchSeason (gn_id)
+    if @userID == nil 
+      registerUser
+    end
+
+    body = "<GN_ID>" + gn_id + "</GN_ID>"
+    data = constructQueryReq(body, "SEASON_FETCH")
+
+    resp = api(data)
+    return checkRES(resp)
+  end
+
+  # Function: fetchTVShow
+  # Fetches details of TV Show from gn_id
+  # Arguments:
+  #   gn_id
+  def fetchTVShow (gn_id)
+    if @userID == nil 
+      registerUser
+    end
+
+    body = "<GN_ID>" + gn_id + "</GN_ID>
+              <OPTION>
+                <PARAMETER>SELECT_EXTENDED</PARAMETER>
+                <VALUE>IMAGE</VALUE>
+              </OPTION>"
+
+    data = constructQueryReq(body, "SERIES_FETCH")
+
+    resp = api(data)
+    return checkRES(resp)
+  end
+
+  # Function: findTVShow
+  # Finds TVShows which matches the name
+  # Arguments:
+  #   name
+  #   single
+  def findTVShow (name, single=true)
+    if @userID == nil 
+      registerUser
+    end
+
+    singleText = single ? '<MODE>SINGLE_BEST</MODE>' : ''
+  
+    body = "<TEXT TYPE='TITLE'>" + name + "</TEXT>
+            " + singleText + "
+            <OPTION>
+              <PARAMETER>SELECT_EXTENDED</PARAMETER>
+              <VALUE>IMAGE</VALUE>
+            </OPTION>"
+
+    data = constructQueryReq(body, "SERIES_SEARCH")
+
+    resp = api(data)
+    return checkRES(resp)
+  end
+
+  # Function: fetchContributor
+  # Fetches details of a contributor from gn_id
+  # Arguments:
+  #   gn_id
+  def fetchContributor (gn_id)
+    if @userID == nil 
+      registerUser
+    end
+
+    body = "<GN_ID>" + gn_id + "</GN_ID>
+            <OPTION>
+              <PARAMETER>SELECT_EXTENDED</PARAMETER>
+              <VALUE>IMAGE,MEDIAGRAPHY_IMAGES</VALUE>
+            </OPTION>"
+
+    data = constructQueryReq(body, "CONTRIBUTOR_FETCH")
+
+    resp = api(data)
+    return checkRES(resp)
+  end
+
+  # Function: findContributor
+  # Find details of a contributor from name
+  # Arguments:
+  #   name
+  def findContributor (name)
+    if @userID == nil 
+      registerUser
+    end
+
+    body = "<TEXT TYPE='NAME'>" + name + "</TEXT>
+              <MODE>SINGLE_BEST</MODE>
+            <OPTION>
+              <PARAMETER>SELECT_EXTENDED</PARAMETER>
+              <VALUE>IMAGE,MEDIAGRAPHY_IMAGES</VALUE>
+            </OPTION>"
+
+    data = constructQueryReq(body, "CONTRIBUTOR_SEARCH")
+    
+    resp = api(data)
+    return checkRES(resp)
+  end
+
+  ###################################################### protected methods ######################################################
   protected
   # Function: api
   # execute a query on gracenote webapi
   # Arguments:
   #   query
   def api (query)
-    resp = HTTP.post(@apiURL, query)
-    return parseRES(resp)
+    return HTTP.post(@apiURL, query)
   end
   
   # Function: constructQueryReq
@@ -165,7 +271,7 @@ class Gracenote
             </QUERIES>"
   end
   
-  # Function: constructQueryBody
+  # Function: constructAlbumQueryBody
   # Constructs query body
   # Arguments:
   #   artist
@@ -174,7 +280,7 @@ class Gracenote
   #   gn_id
   #   command
   #   matchMode
-  def constructQueryBody(artist, album, track, gn_id, command = "ALBUM_SEARCH", matchMode = @@ALL_RESULTS)
+  def constructAlbumQueryBody(artist, album, track, gn_id, command = "ALBUM_SEARCH", matchMode = @@ALL_RESULTS)
     body = ""
     # If a fetch scenario, user the Gracenote ID.
     if command == "ALBUM_FETCH"
@@ -247,11 +353,11 @@ class Gracenote
     return json
   end
   
-  # Function: parseRES
+  # Function: parseAlbumRES
   # Parse's an XML response
   # Arguments:
   #   resp
-  def parseRES resp
+  def parseAlbumRES resp
     json = nil
     begin
       json = checkRES resp

data/lib/gracenote/HTTP.rb

@@ -13,6 +13,7 @@ class HTTP
   def self.get(path, cookie='')
     uri = URI(path)
     req = Net::HTTP.new(uri.host, uri.port)
+    req.read_timeout = 60
     req.use_ssl = (uri.scheme == "https") ? true : false
     headers = {'Cookie' => cookie}
     
@@ -23,6 +24,7 @@ class HTTP
   def self.post(path, data='', cookie='')
     uri = URI(path)
     req = Net::HTTP.new(uri.host, uri.port)
+    req.read_timeout = 60
     req.use_ssl = (uri.scheme == "https") ? true : false
     headers = {'Cookie' => cookie, "Content-Type" => "application/xml"}
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gracenote
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.2.0
 platform: ruby
 authors:
 - nobelium
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-21 00:00:00.000000000 Z
+date: 2014-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler