ckan 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+pkg/*
+*.gem
+.bundle
+.*.sw?

data/Gemfile

@@ -0,0 +1,4 @@
+source :gemcutter
+
+# Specify your gem's dependencies in ckan.gemspec
+gemspec

data/README.txt

@@ -0,0 +1,72 @@
+= CKAN
+
+* http://github.com/apohllo/CKAN
+
+= DESCRIPTION
+
+'CKAN' is a Ruby client of the Comprehensive Knowledge Archive Network.
+
+= FEATURES/PROBLEMS
+
+* The project is in pre-alpha state.
+* CKAN packages REST API wrapper.
+* CKAN resources class.
+* Query API for CKAN packages.
+
+= SYNOPSIS
+
+'CKAN' is a Ruby client for the Comprehensive Knowledge Archive Network. It
+provides an object oriented interface for the repository based on the REST API
+of CKAN.
+
+= INSTALL
+
+The gem is available at rubygems.org, so you can install it with:
+
+  $ gem install ckan
+
+= BASIC USAGE
+
+  require 'ckan'
+
+  # get all CKAN packages
+  packages = CKAN::Package.find
+
+  # query for CKAN packages
+  packages = CKAN::Package.find(:tags => ["lod", "government"], :groups => "lodcloud")
+
+  # get the name of the package (this is a lazy call to the REST API)
+  packages.first.name
+
+  # get the resources of the package
+  packages.first.resources
+
+== LICENSE:
+ 
+(The MIT License)
+
+Copyright (c) 2010 Aleksander Pohl
+
+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.
+
+== FEEDBACK
+
+* mailto:apohllo@o2.pl
+

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/ckan.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path("../lib/ckan/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "ckan"
+  s.version     = CKAN::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Aleksander Pohl"]
+  s.email       = ["apohllo@o2.pl"]
+  s.homepage    = "http://github.com/apohllo/ckan"
+  s.summary     = "Ruby Client for Comprehensive Knowledge Archive Network"
+  s.description = "Ruby Client for Comprehensive Knowledge Archive Network. Allows for querying the CKAN repository using REST API"
+
+  s.required_rubygems_version = ">= 1.3.6"
+  s.rubyforge_project         = "ckan"
+
+  s.add_development_dependency "bundler", ">= 1.0.0"
+
+  s.files        = `git ls-files`.split("\n")
+  s.executables  = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
+  s.require_path = 'lib'
+  s.rdoc_options = ["--main", "README.txt"]
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README.txt"]
+end

data/lib/ckan.rb

@@ -0,0 +1,10 @@
+module CKAN
+  API_BASE = "http://ckan.net/api/2/"
+end
+
+require 'open-uri'
+require 'json'
+require 'ckan/model'
+require 'ckan/package'
+require 'ckan/resource'
+require 'ckan/version'

data/lib/ckan/model.rb

@@ -0,0 +1,44 @@
+module CKAN
+  class Model
+    protected
+
+    def read_lazy_data
+      unless @lazy_data_read 
+        self.class.read_remote_json_data(self.class.site + "/" + self.id).
+          each do |name,value|
+          self.instance_variable_set("@"+name,value)
+        end
+        @lazy_data_read = true
+      end
+    end
+
+    def self.site=(address)
+      @site = address
+    end
+
+    def self.site
+      @site
+    end
+
+    def self.search=(address)
+      @search = address
+    end
+
+    def self.search
+      @search
+    end
+
+    def self.read_remote_json_data(address)
+      JSON.parse(open(address).read)
+    end
+
+    def self.lazy_reader(*names)
+      names.each do |name|
+        define_method(name) do 
+          read_lazy_data
+          instance_variable_get("@" + name.to_s)
+        end
+      end
+    end
+  end
+end

data/lib/ckan/package.rb

@@ -0,0 +1,51 @@
+module CKAN
+  class Package < Model
+    self.site = API_BASE + "rest/package"
+    self.search = API_BASE + "search/package"
+
+    attr_reader :id
+    lazy_reader :name, :title, :url
+
+    def initialize(id)
+      @id = id
+    end
+
+    def self.find(options=nil)
+      if options.nil?
+        @all_packages ||= read_remote_json_data(self.site).map{|id| Package.get(id)}
+      else
+        query = "?"
+        query += options.to_a.
+          map{|k,v| v.is_a?(Array) ? v.map{|vv| "#{k}=#{URI.encode(vv)}"}.join("&") : 
+            "#{k}=#{URI.encode(v)}"}.join("&")
+        puts query
+        result = read_remote_json_data(self.search + query)
+        if result["count"] != result["results"].size
+          query += "&offset=#{result["results"].size}&limit=#{result["count"] + result["results"].size}"
+          result["results"] += read_remote_json_data(self.search + query)["results"] 
+        end
+
+        result["results"].map{|id| Package.get(id)}
+      end
+    end
+
+    def resources
+      read_lazy_data 
+      @mapped_resources ||= @resources.
+        map{|r| Resource.new(r["url"],r["format"],r["description"],r["hash"])}
+    end
+
+    def to_s
+      "CKAN::Package[#{@id}]"
+    end
+
+    protected
+    def self.get(id)
+      @package_map ||= {}
+      unless @package_map[id]
+        @package_map[id] = Package.new(id)
+      end
+      @package_map[id]
+    end
+  end
+end

data/lib/ckan/resource.rb

@@ -0,0 +1,9 @@
+module CKAN
+  class Resource
+    attr_reader :url, :format, :description, :hash
+
+    def initialize(url, format, description, hash)
+      @url, @format, @description, @hash = url, format, description, hash
+    end
+  end
+end

data/lib/ckan/version.rb

@@ -0,0 +1,3 @@
+module CKAN
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification 
+name: ckan
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Aleksander Pohl
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-21 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id001
+description: Ruby Client for Comprehensive Knowledge Archive Network. Allows for querying the CKAN repository using REST API
+email: 
+- apohllo@o2.pl
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.txt
+files: 
+- .gitignore
+- Gemfile
+- README.txt
+- Rakefile
+- ckan.gemspec
+- lib/ckan.rb
+- lib/ckan/model.rb
+- lib/ckan/package.rb
+- lib/ckan/resource.rb
+- lib/ckan/version.rb
+has_rdoc: true
+homepage: http://github.com/apohllo/ckan
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: ckan
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Ruby Client for Comprehensive Knowledge Archive Network
+test_files: []
+