ur-product 0.1

data/MIT-LICENSE

@@ -0,0 +1,18 @@
+Copyright (c) 2010 Peter Hellberg
+ 
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+ 
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+ 
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,34 @@
+# UR::Product
+
+API wrapper for the [Utbildningsradion](http://ur.se) product services.
+
+### Installation
+
+    gem install ur-product
+
+### Related Resources (in Swedish)
+
+  * [Metadata Cache](http://metadata.ur.se)
+  * [Search](http://services.ur.se/search)
+  
+### Example usage
+
+#### Find
+    require 'ur-product'
+    product = UR::Product.find(100001)
+
+#### Search
+    require 'ur-product'
+    UR::Product.search({
+      :queries => 'samtid',
+      :filter => { :search_product_type => 'programtv' },
+      :page => 1,
+      :per_page => 5,
+      :publicstreaming => 'NOW'
+    })
+
+### Dependencies
+
+ * [RSolr](http://github.com/mwmitchell/rsolr)
+ * [RSolr-ext](http://github.com/mwmitchell/rsolr-ext)
+ * [RestClient](http://github.com/archiloque/rest-client)

data/lib/ur/metadata_cache.rb

@@ -0,0 +1,41 @@
+require 'json'
+require 'restclient'
+
+# Module for Utbildningsradion AB (http://ur.se/)
+module UR
+  # Responsible for retrieving metadata and 
+  # populating one or more UR::Product objects
+  class MetadataCache
+    # Setup
+    METADATA_PRODUCT_URL = 'http://metadata.ur.se/products'
+     
+    # Retrieve one or more products
+    def self.find(id)
+      if id.instance_of?(Array)
+        valid_ids = []
+        
+        id.each do |id|
+          if id.to_s.match(/^1\d{5}$/)
+            valid_ids << id 
+          else
+            raise UR::InvalidProductID
+          end
+        end
+        
+        url = METADATA_PRODUCT_URL + ".json?ur_product_ids=#{valid_ids.join(',')}"
+      else
+        raise UR::InvalidProductID if !id.to_s.match(/^1\d{5}$/)
+        url = METADATA_PRODUCT_URL + "/#{id}.json"
+      end
+      
+      # Get the JSON response from the Metadata Cache
+      response = RestClient.get(url)
+      
+      # Make sure that we got a valid response
+      raise UR::InvalidResponse if response.code != 200
+      
+      # Return the response as a parsed JSON object
+      JSON.parse(response.body)
+    end
+  end
+end

data/lib/ur/product.rb

@@ -0,0 +1,118 @@
+# Module for Utbildningsradion AB (http://ur.se/)
+module UR
+  # A product can be a tv show, a radio program or even a website
+  class Product
+    # Setup
+    ASSETS_URL = 'http://assets.ur.se'
+    attr_accessor :related_products,
+                  :ur_product_id, :title, :language, 
+                  :description, :easy_to_read_description,
+                  :obsoleteorderid, :status, :productionyear,
+                  :maintitle, :remainderoftitle, :producingcompany,
+                  :created, :modified, :format, :duration, :aspect_ratio,
+                  :product_type, :product_sub_type, :typical_age_range, 
+                  :pubdate
+    
+    def initialize(data)
+      product_data = data.include?('product') ? data['product'] : data
+      relations = data.include?('relations') ? data['relations'] : []
+      populate(product_data, relations)
+      
+      self.class.define_boolean_methods(['siblings'])
+    end
+    
+    def self.find(id)
+      data = MetadataCache.find(id)
+      
+      (data.instance_of?(Array)) ? 
+        data.map { |d| Product.new(d) } : Product.new(data)
+    end
+    
+    def self.search(solr_params)
+      UR::Search.new(solr_params)
+    end
+    
+    def self.define_boolean_methods(names)
+      names.each do |name|
+        define_method("has_#{name}?") do
+          related_products = instance_variable_get("@related_products")
+          (!related_products.nil? && !related_products[name].nil?)
+        end
+      end
+    end
+    
+    def self.define_relation_accessor(name)
+      define_method(name) do
+        instance_variable_get("@related_products")[name]
+      end
+    end
+    
+    # Populate the object
+    def populate(product_data, relations)
+      # Handle the fields
+      standard_fields = [
+        'id', 'obsoleteorderid', 'status', 'language', 
+        'title.sv', 'maintitle.sv', 'remainderoftitle.sv',
+        'description.sv', 'easytoreaddescription.sv',
+        'productionyear', 'producingcompany',
+        'created', 'modified', 'pubdate', 
+        'format', 'duration', 'aspect_ratio',
+        'product_type', 'product_sub_type', 
+        'typical_age_range'
+      ]
+      
+      field_names = lambda do |name|
+        renamed = { 
+          'id' => 'ur_product_id', 
+          'easytoreaddescription' => 'easy_to_read_description',
+          'typicalagerange' => 'typical_age_range'
+        }
+        (renamed.include?(name)) ? renamed[name] : name
+      end
+      
+      standard_fields.each do |field|
+        field,lang = field.split('.')
+        
+        if lang.nil?
+          value = product_data[field]
+        elsif !product_data[field].nil?
+          value = product_data[field][lang]
+        end
+        
+        self.send("#{field_names.call(field)}=", value)
+      end
+      
+      # Handle the relations
+      if relations.size > 0
+        @related_products = {}
+        @has_relations = true
+        relations.each do |name, products|
+          @related_products[name] = []
+          
+          products.each do |related_product_data|
+            @related_products[name] << Product.new(related_product_data)
+          end
+          
+          self.class.define_relation_accessor(name)
+        end
+      end
+    end
+
+    def has_image?
+      return @has_image if !@has_image.nil?
+      
+      begin
+        url = "#{ASSETS_URL}/id/#{ur_product_id}/images/1.jpg"
+        @has_image = (RestClient.head(url).headers[:x_ur_http_status] == "200")
+      rescue RestClient::ResourceNotFound
+        @has_image = false
+      end
+      
+      @has_image
+    end
+
+    def has_relations?
+      (!@related_products.nil? && @related_products.size > 0)
+    end
+  end
+end

data/lib/ur/search.rb

@@ -0,0 +1,43 @@
+require 'rsolr-ext'
+
+# Module for Utbildningsradion AB (http://ur.se/)
+module UR  
+  # Search for products and populate from the metadata cache
+  class Search
+    # Setup
+    SEARCH_SERVICE_URL = 'http://services.ur.se/search'
+    attr_accessor :products, :solr, :facets
+    
+    def initialize(solr_params)
+      solr = RSolr.connect :url => SEARCH_SERVICE_URL
+      response = solr.find solr_params
+      
+      # Populate the products from the Metadata Cache
+      @products = (response.ok? && response.docs.size > 0) ?
+        Product.find(response.docs.map { |d| d.id }) : []
+      
+      # Expose the Solr response
+      @solr = response
+      
+      # Prepare the facets
+      @facets = {}
+      @solr.facets.map { |f| @facets[f.name] = f.items } if @solr.facets.size > 0
+    end
+    
+    def num_found
+      @solr.response['numFound'].to_i
+    end
+    
+    def ok?
+      @solr.ok?
+    end
+    
+    def previous_page
+      @solr.docs.previous_page
+    end
+    
+    def next_page
+      @solr.docs.next_page
+    end
+  end
+end

data/lib/ur-product.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '/ur/metadata_cache'
+require File.dirname(__FILE__) + '/ur/product'
+require File.dirname(__FILE__) + '/ur/search'
+
+module UR
+  class InvalidProductID < Exception
+  end
+  
+  class InvalidResponse < Exception
+  end
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification 
+name: ur-product
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  version: "0.1"
+platform: ruby
+authors: 
+- Peter Hellberg
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-22 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 3
+        version: 1.2.3
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rsolr
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 12
+        - 1
+        version: 0.12.1
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rsolr-ext
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 12
+        - 0
+        version: 0.12.0
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 4
+        - 2
+        version: 1.4.2
+  type: :runtime
+  version_requirements: *id004
+description: Enables searching and fetching of Utbildningsradion products
+email: peter@c7.se
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.markdown
+- MIT-LICENSE
+- lib/ur-product.rb
+- lib/ur/metadata_cache.rb
+- lib/ur/product.rb
+- lib/ur/search.rb
+has_rdoc: true
+homepage: http://github.com/c7/ur-product
+licenses: 
+- MIT-LICENSE
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: ur-product
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: API wrapper for the Utbildningsradion product services
+test_files: []
+