daylife 0.1.0

data/History.txt

@@ -0,0 +1,4 @@
+== 0.1.0 2007-12-04
+
+* 1 major enhancement:
+  * Initial release

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2007 Bobby Uhlenbrock
+
+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/Manifest.txt

@@ -0,0 +1,25 @@
+History.txt
+License.txt
+Manifest.txt
+README.txt
+Rakefile
+config/hoe.rb
+config/requirements.rb
+lib/daylife.rb
+lib/daylife/version.rb
+lib/daylife/base.rb
+lib/daylife/article.rb
+lib/daylife/quote.rb
+lib/daylife/search.rb
+lib/daylife/topic.rb
+lib/daylife/image.rb
+lib/daylife/source.rb
+log/debug.log
+script/destroy
+script/generate
+script/txt2html
+setup.rb
+tasks/deployment.rake
+tasks/environment.rake
+test/test_daylife.rb
+test/test_helper.rb

data/README.txt

@@ -0,0 +1,27 @@
+== Daylife API Library for Ruby
+
+Copyright Bobby Uhlenbrock (buhlenbrock@thinkbarefoot.com) 2007
+
+A fully featured Ruby library for accessing the Daylife DayPI
+
+	Daylife.authenticate('8befa1cf0a7c0291613242235638a662', '2e548ef751397c653752057adcff0c9f')
+	articles = Daylife::Article.get_related_articles('03cV5zI2fk03s')
+
+When in doubt check the Daylife DayPI documentation:
+
+http://developer.daylife.com/docs/DayPI101
+
+=== Installation and Usage
+
+To get an accesskey:
+
+	http://developer.daylife.com/member/register
+
+To install:
+
+	sudo gem install path/to/daylife-xxx.gem
+	
+To use:
+
+	require 'rubygems'
+	require 'daylife'

data/Rakefile

@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/config/hoe.rb

@@ -0,0 +1,71 @@
+require 'daylife/version'
+
+AUTHOR = 'Bobby Uhlenbrock'  # can also be an array of Authors
+EMAIL = "buhlenbrock@thinkbarefoot.com"
+DESCRIPTION = "A fully featured Ruby library for accessing the Daylife DayPI"
+GEM_NAME = 'daylife' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'daylife' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "unknown"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil 
+# UNCOMMENT IF REQUIRED: 
+# REV = `svn info`.each {|line| if line =~ /^Revision:/ then k,v = line.split(': '); break v.chomp; else next; end} rescue nil
+VERS = Daylife::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'daylife documentation',
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps 
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' } 
+    @extra_deps
+  end 
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.author = AUTHOR 
+  p.description = DESCRIPTION
+  p.email = EMAIL
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+  
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  #p.extra_deps = []     # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ]
+  
+  #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  
+end
+
+CHANGES = hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+hoe.rsync_args = '-av --delete --ignore-errors'

data/config/requirements.rb

@@ -0,0 +1,17 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))
+
+require 'daylife'

data/lib/daylife.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH << File.expand_path(File.dirname(__FILE__) + "/daylife")
+
+require 'base'
+require 'article'
+require 'quote'
+require 'search'
+require 'topic'
+require 'image'
+require 'source'

data/lib/daylife/article.rb

@@ -0,0 +1,44 @@
+class Daylife::Article < Daylife::API
+  
+  attr_accessor :article_id, :daylife_url, :excerpt, :headline, :image, :quote_story_relevance, :source, :timestamp, :url
+  
+  def self.core_identifier
+    return :article_id
+  end
+  
+  # This function returns basic information about a given article.
+  def self.get_info(article_id, parameters={})
+    get :get_info, parameters.merge(:article_id => article_id)
+  end
+  
+  # This method is used to retrieve articles that are related to the given article.
+  def self.get_related_articles(article_id, parameters={})
+    get :get_related_articles, parameters.merge(:article_id => article_id)
+  end
+  
+  # This method is used to retrieve images from articles related to the given article.
+  def self.get_related_images(article_id, parameters={})
+    get :get_related_images, parameters.merge(:article_id => article_id)
+  end
+  
+  # This method is used to retrieve quotes from articles related to the given article.
+  def self.get_related_quotes(article_id, parameters={})
+    get :get_related_quotes, parameters.merge(:article_id => article_id)
+  end
+  
+  # This method is used to retrieve topics from articles related to the given article.
+  def self.get_related_topics(article_id, parameters={})
+    get :get_related_topics, parameters.merge(:article_id => article_id)
+  end
+  
+  # This method is used to retrieve quotes from within the given article.
+  def self.get_quotes(article_id, parameters={})
+    get :get_quotes, parameters.merge(:article_id => article_id)
+  end
+  
+  # This method is used to retrieve topics from within the given article.
+  def self.get_topics(article_id, parameters={})
+    get :get_topics, parameters.merge(:article_id => article_id)
+  end
+    
+end

data/lib/daylife/base.rb

@@ -0,0 +1,167 @@
+require 'rexml/document'
+require 'net/http'
+require 'md5'
+require 'cgi'
+require 'time'
+
+module Daylife
+  
+  class DaylifeError < StandardError; end
+  class BadResponse < DaylifeError; end
+  class BadRequest < DaylifeError; end
+  class ObjectNotSupported < DaylifeError; end
+  
+  # The accesskey and shared_secret are stored within the Daylife::API class
+  # where they are used to create the unique signature for each call.
+  def self.authenticate(accesskey, shared_secret)    
+    API.auth[:accesskey] = accesskey
+    API.auth[:shared_secret] = shared_secret
+  end
+  
+  # DayPI 101: http://developer.daylife.com/docs/DayPI101
+  # 
+  # The DayPI call responses include codes indicating success or failure as well as a message 
+  # with some explanation or helpful tip in cases of failure. For acurrent list of response/error 
+  # codes and messages, see http://developer.daylife.com/docs/Response_Error_Codes
+  #
+  # Sample Usage
+  #
+  #     Daylife.authenticate('8befa1cf0a7c0291613242235638a662', '2e548ef751397c653752057adcff0c9f')
+  #     articles = Daylife::Article.get_related_articles('03cV5zI2fk03s')
+  class API
+    
+    @@auth = { :accesskey => '', :shared_secret => '' }
+    
+    def initialize(props={})
+      props.each do |key, val|
+        setter = "#{key}=".intern
+        self.send setter, val if respond_to? setter
+      end
+    end
+    
+    def self.auth
+      @@auth
+    end
+    
+    # Make a get request to the input method with a parameters hash.
+    # Returbs an instanceor list of instances of API objects.
+    #
+    #     Article.get :get_topics, :article_id => 03cV5zI2fk03s
+    #
+    # Generates the request:
+    #
+    #     article_getTopics?accesskey=<accesskey>&signature=<signature>&article_id=03cV5zI2fk03s
+    def self.get(method, parameters={})
+      parameters = @@auth.merge(parameters)
+      resp = Request.new(methodize(method)).get(parameters)
+      resp.parse
+    end
+    
+    # Creates a Daylife style method name from a symbol.
+    #     Article.methodize :get_topics #=> "article_getTopics"
+    def self.methodize(method)
+      "#{name.split('::').last.downcase}_#{method.to_s.gsub(/_([a-z])/) { $1.upcase }}"
+    end
+    
+  end
+
+  class Request
+    
+    BASE_URL = 'http://freeapi.daylife.com/xmlrest/publicapi/4.3/'
+    
+    def initialize(method)
+      @method = method
+    end
+    
+    def get(parameters)
+      # Create the signature
+      parameters[:signature] = create_signature(@method.split("_").first, parameters) unless parameters[:signature]
+      parameters.delete_if { |key, value| key == :shared_secret }
+      # Convert Time objects to strings with correct format
+      parameters[:start_time] = parameters[:start_time].strftime("%Y-%m-%d %H:%M:%S") if (parameters[:start_time] && parameters[:start_time].kind_of?(Time))
+      parameters[:end_time] = parameters[:end_time].strftime("%Y-%m-%d %H:%M:%S") if (parameters[:end_time] && parameters[:end_time].kind_of?(Time))
+      # Build the URL
+      query_string = "#{@method}?" << build_params(parameters)
+      url = URI.parse(BASE_URL + query_string)
+      puts url
+      response = Net::HTTP.get_response(url)
+      if response.kind_of?(Net::HTTPSuccess)
+        return Response.new(response.body)
+      else
+        raise Daylife::BadRequest, "Failed with message: #{response.code}"
+      end
+    end
+    
+    protected
+    
+      def build_params(parameters)
+        parameters.collect { |key, value| 
+          "#{key.to_s}=#{CGI::escape(value.to_s)}" if value
+        }.compact.join "&"
+      end
+        
+      def create_signature(news_object, parameters)
+        core_identifier = Module.const_get("Daylife").const_get(news_object.capitalize).core_identifier.to_sym
+        Digest::MD5.hexdigest(parameters[:accesskey] + parameters[:shared_secret] + parameters[core_identifier])
+      end
+      
+  end
+
+  class Response
+
+    def initialize(response)
+      @document = REXML::Document.new(response)
+    end
+    
+    def parse
+      if self.success?
+        objects = @document.elements['/response/payload']
+        # Prevent empty requests from showing up in the array.
+        unless objects.size == 1 && objects[0].children.size == 0
+          objects.collect { |o| get_object(o) }
+        else
+          return []
+        end
+      else
+        raise Daylife::BadResponse, "Failed with message: #{self.message} (#{self.code})"
+      end
+    end
+
+    def code
+      @document.elements['/response/code'].text.to_i
+    end
+
+    def message
+      @document.elements['/response/message/'].text  
+    end
+
+    def success?
+      self.code == 2001 || self.code == 2002
+    end
+    
+    protected
+      
+      def get_object(element)
+        begin
+          klass = Module.const_get("Daylife").const_get(element.name.capitalize)
+        rescue
+          raise ObjectNotSupported, "Daylife::#{element.name.capitalize}"
+        end
+        children = Hash.new
+        # Iterate through the nodes recursively.
+        element.children.each do |child|
+          if child.children.size > 1
+            children[child.name] = get_object(child)
+          else
+            value = child.text
+            value = child.to_i if (type = child.attributes["type"] && (type == 'int4' || type == 'int8'))
+            value = Time.parse(value) if (child.name == 'timestamp')
+            children[child.name] = value
+          end
+        end
+        klass.new children
+      end
+
+  end
+  
+end

data/lib/daylife/image.rb

@@ -0,0 +1,19 @@
+class Daylife::Image < Daylife::API
+  
+  attr_accessor :caption, :credit, :daylife_url, :height, :image_id, :source, :timestamp, :thumb_url, :url, :width
+  
+  def self.core_identifier
+    return :image_id
+  end
+  
+  # This function returns basic information about a given image.
+  def self.get_info(image_id, parameters={})
+    get :get_info, parameters.merge(:image_id => image_id)
+  end
+  
+  # This method is used to retrieve topics that are related to the given image.
+  def self.get_related_topics(image_id, parameters={})
+    get :get_related_topics, parameters.merge(:image_id => image_id)
+  end
+  
+end

data/lib/daylife/quote.rb

@@ -0,0 +1,29 @@
+class Daylife::Quote < Daylife::API
+  
+  attr_accessor :article, :name, :quote_id, :quote_text, :source, :timestamp
+  
+  def self.core_identifier
+    return :quote_id
+  end
+  
+  # This method returns basic information for a quote.
+  def self.get_info(quote_id, parameters={})
+    get :get_info, parameters.merge(:quote_id => quote_id)
+  end
+  
+  # This method is used to retrieve articles that are related to the article that contains the given quote.
+  def self.get_related_articles(quote_id, parameters={})
+    get :get_related_articles, parameters.merge(:quote_id => quote_id)
+  end
+  
+  # This method is used to retrieve quotes from articles that are related to the article containing the given quote.
+  def self.get_related_quotes(quote_id, parameters={})
+    get :get_related_quotes, parameters.merge(:quote_id => quote_id)
+  end
+  
+  # This method is used to retrieve topics from articles that are related to the article containing the given quote.
+  def self.get_related_topics(quote_id, parameters={})
+    get :get_related_topics, parameters.merge(:quote_id => quote_id)
+  end
+  
+end