eyeq_metadata 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4f801b5c424d6f085858aadf460c3d5ca43d001a
+  data.tar.gz: 8d2fe0f0fdfa6ab27faf891831dff80e1eeb928c
+SHA512:
+  metadata.gz: cac3cd3b1dd923852bd1815f9f4c7b150598aae3914e6d803c20acea3a8cc1da80c69302511393184972a8ad82b063fd6f6e26c15fddaf38da0e6aee2b056ba7
+  data.tar.gz: 284b6507154563354581dc941dfd4d1841fd03feee6e3464b7fcc53a2338210348dd1ae23144e7d205ecde6c5885ae482e9000a200443de2ca8fa52ac85cb109

data/lib/eyeq_metadata.rb

@@ -0,0 +1,89 @@
+require 'rest-client'
+require 'nokogiri'
+
+class EyeQ
+  attr_reader :eyeq_url, :eyeq_userid, :eyeq_clientid
+
+  def initialize(clientid, clientid_tag)
+    @eyeq_url = "https://c#{clientid}.ipg.web.cddbp.net/webapi/xml/1.0/"
+    @eyeq_clientid = "#{clientid}-#{clientid_tag}"
+
+    register_query = "<QUERIES><QUERY CMD='REGISTER'><CLIENT>#{@eyeq_clientid}</CLIENT></QUERY></QUERIES>"
+    response = RestClient.post(@eyeq_url, register_query, content_type: 'text/xml')
+    response_xml = Nokogiri::XML(response.body)
+
+    raise 'Invalid clientid or clientid_tag. Query returned an ERROR.' if response_xml.css('RESPONSE').attr('STATUS').text == 'ERROR'
+    @eyeq_userid = response_xml.css('USER').text
+  end
+
+  def request(options)
+    query = construct_query(options)
+    response = RestClient.post(@eyeq_url, query, content_type: 'text/xml')
+    Nokogiri::XML(response.body)
+  end
+
+  private
+
+  def construct_query(options)
+    query = '<QUERIES>'
+    query += options[:lang].nil? ? lang : lang(options[:lang])
+    query += options[:country].nil? ? country : country(options[:country])
+    query + "#{auth}#{get_query_type(options)}</QUERIES>"
+  end
+
+  def get_query_type(options)
+    query_type = nil
+
+    case options[:query_type].downcase
+    when 'tvchannel_fetch'
+      throw new Error(':gnid option required') if options[:gnid].nil?
+      query_type = tvchannel_fetch(options[:gnid])
+    when 'tvchannel_lookup_by_provider'
+      throw new Error(':gnid option required') if options[:gnid].nil?
+      query_type = tvchannel_lookup_by_provider(options[:gnid])
+    when 'tvprovider_na'
+      throw new Error(':zipcode option required') if options[:zipcode].nil?
+      query_type = tvprovider_na(options[:zipcode])
+    when 'tvprovider_or'
+      throw new Error(':tvregion option required') if options[:tvregion].nil?
+      query_type = tvprovider_or(options[:tvregion])
+    when 'tvprogram_fetch'
+      throw new Error(':gnid option required') if options[:gnid].nil?
+      query_type = tvprogram_fetch(options[:gnid])
+    end
+
+    query_type
+  end
+
+  def lang(lang = 'eng')
+    "<LANG>#{lang}</LANG>"
+  end
+
+  def country(country = 'usa')
+    "<COUNTRY>#{country}</COUNTRY>"
+  end
+
+  def auth
+    "<AUTH><CLIENT>#{@eyeq_clientid}</CLIENT><USER>#{@eyeq_userid}</USER></AUTH>"
+  end
+
+  def tvchannel_fetch(gnid)
+    "<QUERY CMD='TVCHANNEL_FETCH'><GN_ID>#{gnid}</GN_ID></QUERY>"
+  end
+
+  def tvchannel_lookup_by_provider(gnid)
+    "<QUERY CMD='TVCHANNEL_LOOKUP'><MODE>TVPROVIDER</MODE><GN_ID>#{gnid}</GN_ID></QUERY>"
+  end
+
+  def tvprovider_na(zipcode)
+    "<QUERY CMD='TVPROVIDER_LOOKUP'><POSTALCODE>#{zipcode}</POSTALCODE></QUERY>"
+  end
+
+  def tvprovider_or(tvregion)
+    "<QUERY CMD='TVPROVIDER_LOOKUP'><TVREGION>#{tvregion}</TVREGION></QUERY>"
+  end
+
+  def tvprogram_fetch(gnid)
+    "<QUERY CMD='TVPROGRAM_FETCH'><GN_ID>#{gnid}</GN_ID></QUERY>"
+  end
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: eyeq_metadata
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Isaiah Soung
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.41.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.41.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+description: Request Gracenote EyeQ metadata using the eyeq api
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/eyeq_metadata.rb
+homepage: https://github.com/Isoung/eyeq_metadata
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: HTTP client used specifically to request metadata from Gracenote EyeQ
+test_files: []