jamesotron-digitalnz 0.1.1

data/README.rdoc

@@ -0,0 +1,36 @@
+= DigitalNZ
+
+== Description
+
+A small gem to interface with the DigitalNZ API at http://www.digitalnz.org/
+
+== Installation
+
+=== Stable
+
+    sudo gem install digitalnz
+
+=== Bleeding Edge
+
+    $ git clone git://github.com/jamesotron/digitalnz.git
+    $ cd digitalnz
+    $ rake gem && sudo gem install pkg/digitalnz-<version>.gem
+
+== Usage
+
+To get started you'll need to grab an API key from DigialNZ, you can get this here: http://www.digitalnz.org/dashboard/api_key
+
+Now that you've got your API key you can try using it:
+
+    $ irb -r rubygems
+    >> require 'digitalnz'
+
+Next, set your API key (you only need to do this once per session):
+
+    >> DigitalNZ.api_key = '<your api key here>'
+
+== License
+
+Copyright (c) 2009 James Harton (jamesotron@gmail.com)
+
+Please see the LICENSE file with this distribution.

data/Rakefile

@@ -0,0 +1,38 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'rake/testtask'
+
+require 'lib/digitalnz/version'
+
+task :default => :test
+
+spec = Gem::Specification.new do |s|
+  s.name             = 'digitalnz'
+  s.version          = DigitalNZ::Version.to_s
+  s.has_rdoc         = true
+  s.extra_rdoc_files = %w(README.rdoc)
+  s.rdoc_options     = %w(--main README.rdoc)
+  s.summary          = "A small gem to interface with the DigitalNZ API"
+  s.author           = 'James Harton'
+  s.email            = 'jamesotron@gmail.com'
+  s.homepage         = 'http://www.helicopter.geek.nz/'
+  s.files            = %w(README.rdoc Rakefile) + Dir.glob("{lib,test}/**/*")
+  
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
+end
+
+desc 'Generate the gemspec to serve this Gem from Github'
+task :github do
+  file = File.dirname(__FILE__) + "/#{spec.name}.gemspec"
+  File.open(file, 'w') {|f| f << spec.to_ruby }
+  puts "Created gemspec: #{file}"
+end

data/lib/digitalnz.rb

@@ -0,0 +1,39 @@
+module DigitalNZ
+
+  @@api_key = 0
+
+  def self.api_key
+    @@api_key
+  end
+
+  def self.api_key=(x)
+    @@api_key = x
+  end
+
+  def self.search(params)
+    params = { :search_text => params.to_s } unless params.is_a?(Hash)
+    params[:api_key]=@@api_key
+    DigitalNZ::Search.new(params)
+  end
+
+  def self.record(url)
+    DigitalNZ::Record.new(url)
+  end
+
+end
+
+def require_local(suffix)
+  require(File.expand_path(File.join(File.dirname(__FILE__), suffix)))
+end
+
+# External requires
+require('rubygems')
+require('net/http')
+require('uri')
+require('json')
+require('cgi')
+
+# Local requires.
+require_local('digitalnz/search')
+require_local('digitalnz/record')
+require_local('digitalnz/version')

data/lib/digitalnz/record.rb

@@ -0,0 +1,35 @@
+class DigitalNZ::Record
+
+  def initialize(url)
+    query = [ "api_key=" + CGI.escape(DigitalNZ.api_key) ]
+    url += ".json?" + query * "&"
+    puts url
+    res = fetch(url)
+    res = JSON.parse(res.body)
+    puts res.to_yaml
+  end
+
+  def id
+    @id
+  end
+
+  def url
+    @url
+  end
+
+  private
+
+  def fetch(uri_str, limit = 10) 
+    # You should choose better exception.
+    raise ArgumentError, 'HTTP redirect too deep' if limit == 0
+
+    response = Net::HTTP.get_response(URI.parse(uri_str))
+    case response
+    when Net::HTTPSuccess     then response
+    when Net::HTTPRedirection then fetch(response['location'], limit - 1)
+    else
+      response.error!
+    end
+  end
+
+end

data/lib/digitalnz/search.rb

@@ -0,0 +1,130 @@
+class DigitalNZ::Search
+
+  def initialize(params) 
+    url = 'http://api.digitalnz.org/records/v1.json/?'
+    query = []
+    for k,v in params
+      query += [ k.to_s + '=' + CGI.escape(v) ]
+    end
+    url += query * "&"
+    puts url
+    res = fetch(url)
+    res = JSON.parse(res.body)
+    @orig = res
+    @num_results_requestes = res['num_results_requested'] || nil
+    @count = res['result_count'] || nil
+    @start = res['start'] || nil
+    @results = []
+    for r in res['results']
+      @results << Result.new(r)
+    end
+  end
+
+  def num_results_requested
+    @num_results_requested
+  end
+
+  def count
+    @count
+  end
+
+  def start
+    @start
+  end
+
+  def results
+    @results
+  end
+
+  def to_yaml
+    @orig.to_yaml
+  end
+
+  class Result 
+
+    def initialize(args)
+      @args = args
+      @category = args['category'] if args['category']
+      @title = args['title'] if args['title']
+      @content_provider = args['content_provider'] if args['content_provider']
+      @date = DateTime.parse(args['date']) if (args['date'] and args['date'].size > 1)
+      @syndication_date = DateTime.parse(args['syndication_date']) if args['syndication_date'] and args['syndication_date'].size
+      @description = args['description'] if args['description']
+      @id = args['id'] if args['id']
+      @source_url = args['source_url'] if args['source_url']
+      @display_url = args['display_url'] if args['display_url']
+      @thumbnail_url = args['thumbnail_url'] if args['thumbnail_url']
+      @metadata_url = args['metadata_url'] if args['metadata_url']
+    end
+
+    def category
+      @category
+    end
+
+    def title
+      @title
+    end
+
+    def content_provider
+      @content_provider
+    end
+
+    def date
+      @date
+    end
+
+    def syndication_date
+      @syndication_date
+    end
+
+    def description
+      @description
+    end
+
+    def display_url
+      @display_url
+    end
+
+    def id
+      @id
+    end
+
+    def metadata
+      if !@metadata.nil?
+        @metadata
+      else 
+        @metadata = DigitalNZ.record(@metadata_url) if @metadata_url
+      end
+    end
+
+    def source_url
+      @source_url
+    end
+
+    def thumbnail_url
+      @thumbnail_url
+    end
+
+    def to_yaml
+      @args.to_yaml
+    end
+
+  end
+
+  private
+
+  def fetch(uri_str, limit = 10) 
+    # You should choose better exception.
+    raise ArgumentError, 'HTTP redirect too deep' if limit == 0
+
+    response = Net::HTTP.get_response(URI.parse(uri_str))
+    case response
+    when Net::HTTPSuccess     then response
+    when Net::HTTPRedirection then fetch(response['location'], limit - 1)
+    else
+      response.error!
+    end
+  end
+
+end
+

data/lib/digitalnz/version.rb

@@ -0,0 +1,13 @@
+module DigitalNZ
+  module Version # :nodoc:
+
+    MAJOR = 0
+    MINOR = 1
+    TINY  = 1
+
+    def self.to_s
+      [MAJOR, MINOR, TINY].join('.')
+    end
+
+  end
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification 
+name: jamesotron-digitalnz
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- James Harton
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-10 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: jamesotron@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- Rakefile
+- lib/digitalnz
+- lib/digitalnz/search.rb
+- lib/digitalnz/record.rb
+- lib/digitalnz/version.rb
+- lib/digitalnz.rb
+has_rdoc: true
+homepage: http://github.com/jamesotron/digitalnz/tree/master
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: digitalnz
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: A small gem to interface with the DigitalNZ API
+test_files: []
+