subj3ct 0.0.1 → 0.0.2

data/README.markdown

@@ -63,9 +63,8 @@ The official name is "Subj3ct", however in this API, you can also use "Subject"
 
 ## Plans
 
- * starts_with doesn't work at all. It looks like this is a server side problem.
  * Documentation. Currently the code is barely documented, this should be changed soon.
- * Write tests. Uh... of course we have tests... they're almost done...
+ * Write more tests: fetching, pagination, ...
  * Write support. Currently this lib is only reading subj3ct.com. It should be able to register feeds with the service and to create a feed from existing data.
  * Caching. A minimal caching solution should be built in.
  * Reduce dependencies. Currently this lib uses active_support only for `blank?`. Instead of open-uri a direct HTTP call could be done.

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/lib/subj3ct.rb

@@ -9,7 +9,9 @@ begin
   require 'subj3ct/query'
   require 'subj3ct/register'
   require 'subj3ct/feed'
-rescue LoadError
-  $LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__)))
+rescue LoadError => e
+  here_path = File.expand_path(File.dirname(__FILE__))
+  raise e if $LOAD_PATH.include?(here_path)
+  $LOAD_PATH.unshift(here_path)
   retry
 end

data/lib/subj3ct/query.rb

@@ -1,4 +1,4 @@
-require 'active_support'
+require 'active_support/core_ext/object/blank'
 require 'open-uri'
 require 'json'
 require 'cgi'
@@ -23,13 +23,13 @@ module Subj3ct
       SearchResult.new(request("/webaddresses", params.merge(:uri => representationUri)))
     end
 
-    # uriStartsWith: Must be a URI value. All subjects whose identifier starts with the URI provided are returned.
+    # uri: Must be a URI value. All subjects whose identifier starts with the URI provided are returned. Be sure not to include http:// in the query or it will return nothing.
     # [optional] skip: An integer value that indicates how many results to skip before the service starts returning results.
     # [optional] take: An integer value that indicates how many results to take and return. [Default = 10, Max Cut Off = 50]
     # [optional] format: Allowed values are [default]'xml', 'json'. Used to indicate the representation format to be returned.
     # [optional] callback: Any string that will be used to wrap the json returned. Ignored if the format value is not 'json'
     def starts_with(uri, params={})
-      SearchResult.new(request("/identifiers", params.merge(:uriStartsWith => uri)))
+      SearchResult.new(request("/identifiers", params.merge(:uri => uri)))
     end
 
     # query: String value. The query term is used to search the subjects to find matches based on name, description and identifier. For more information and syntax for advanced options please see the guide on portal search options.
@@ -135,6 +135,11 @@ module Subj3ct
         end
       end
       
+      # TODO: should Enumerable be included here? Or all its methods delegated?
+      def each(*args,&block)
+        @subjects.each(*args, &block)
+      end
+      
       def size
         @subjects.size
       end

data/spec/spec_helper.rb

@@ -1,5 +1,6 @@
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rubygems'
 require 'subj3ct'
 require 'spec'
 require 'spec/autorun'

data/spec/subj3ct_spec.rb

@@ -1,7 +1,55 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe "Subj3ct" do
-  it "fails" do
-    fail "hey buddy, you should probably rename this file and start specing for real"
+  it "should define the namespace Subj3ct" do
+    fail unless defined?(::Subj3ct)
+    Subj3ct.should be_a_kind_of Module
   end
+  
+  it "should define the namespace Subject equivalent to Subj3ct" do
+    fail unless defined?(::Subject)
+    ::Subject.should be_a_kind_of Module
+    ::Subj3ct.should == ::Subject
+  end
+  
+  it "should have the four query methods" do
+    Subj3ct.should respond_to :identifier
+    Subj3ct.should respond_to :resource
+    Subj3ct.should respond_to :starts_with
+    Subj3ct.should respond_to :search
+  end
+  
+  describe "identifier" do
+    it "should fetch a subject by identifier" do
+      sir =  Subj3ct.identifier("http://bock.be/njamin")
+      sir.should be_a_kind_of Subj3ct::Query::SubjectIdentityRecord
+    end
+  end
+  
+  describe "resource" do
+    it "should fetch one or more subjects by resource" do
+      sr =  Subj3ct.resource("http://bock.be/njamin")
+      sr.should be_a_kind_of Subj3ct::Query::SearchResult
+      sr.size.should >= 1
+    end
+  end    
+
+  describe "starts_with" do
+    it "should fetch one or more subjects by prefix of it's identifier" do
+      sr =  Subj3ct.starts_with("bock.be/njamin")
+      sr.should be_a_kind_of Subj3ct::Query::SearchResult
+      sr.size.should >= 1
+    end
+  end    
+
+  describe "search" do
+    it "should search for keywords" do
+      sr =  Subj3ct.search("topic maps")
+      sr.should be_a_kind_of Subj3ct::Query::SearchResult
+      # there are more than 10000 results now, I don't expect it will become less than 50
+      sr.size.should == 50
+      sr.total.should > 50
+    end
+  end    
+
 end

data/subj3ct.gemspec

@@ -0,0 +1,108 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{subj3ct}
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Benjamin Bock"]
+  s.date = %q{2010-06-21}
+  s.description = %q{==== subj3ct - The DNS for the Semantic Web
+
+This is a Ruby adapter for the subj3ct.com webservice.
+
+Subj3ct is an infrastructure technology for Web 3.0 applications. These are
+applications that are organised around subjects and semantics rather than
+documents and links. Subj3ct provides the technology and services to enable
+Web 3.0 applications to define and exchange subject definitions.
+
+Or in other words: Subj3ct.com is for the Semantic Web what DNS is for the internet.
+
+==== Installing
+
+Install the gem:
+
+    gem install subj3ct
+
+==== Usage
+
+Query a specific subject - to be specific: its subject identity record -  using it's identifier:
+
+ Subj3ct.identifier("http://www.topicmapslab.de/publications/TMRA_2009_subj3ct_a_subject_identity_resolution_service")
+
+See the README or the github page for more examples.
+
+==== Subj3ct vs. Subject
+
+The official name is "Subj3ct", however in this API, you can also use "Subject" which may be easier to remember or to type for normal, n0n-1337 people. It should work for the gem, for the require and for the main module.
+
+==== Contribute!
+
+Subj3ct is a young and ambitious service. It's free, will stay free and needs your help. Contribute to this library! Create bindings for other languages! Publish your data as linked data to the web and register it with subj3ct.com.
+
+==== Note on Patches/Pull Requests
+ 
+ * Fork the project on http://github.bb/subj3ct
+ * Make your feature addition or bug fix.
+ * Add tests for it. This is important so I don't break it in a future version unintentionally.
+ * Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+ * Send me a pull request. Bonus points for topic branches.
+
+==== Copyright
+
+Copyright (c) 2010 Benjamin Bock, Topic Maps Lab. See LICENSE for details.
+}
+  s.email = %q{bb--github.com@bock.be}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.markdown"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "GemDescription.sm",
+     "LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "lib/subj3ct.rb",
+     "lib/subj3ct/feed.rb",
+     "lib/subj3ct/query.rb",
+     "lib/subj3ct/register.rb",
+     "lib/subject.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "spec/subj3ct_spec.rb",
+     "subj3ct.gemspec",
+     "subject.gemspec"
+  ]
+  s.homepage = %q{http://github.com/bb/subj3ct}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Ruby bindings for Subj3ct.com, the DNS for the semantic web.}
+  s.test_files = [
+    "spec/spec_helper.rb",
+     "spec/subj3ct_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<yard>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<yard>, [">= 0"])
+  end
+end
+

data/subject.gemspec

@@ -0,0 +1,82 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{subject}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Benjamin Bock"]
+  s.date = %q{2010-06-15}
+  s.description = %q{==== subj3ct - The DNS for the Semantic Web
+
+This is a Ruby adapter for the subj3ct.com webservice.
+
+Subj3ct is an infrastructure technology for Web 3.0 applications. These are
+applications that are organised around subjects and semantics rather than
+documents and links. Subj3ct provides the technology and services to enable
+Web 3.0 applications to define and exchange subject definitions.
+
+Or in other words: Subj3ct.com is for the Semantic Web what DNS is for the internet.
+
+==== Installing
+
+Install the gem:
+
+    gem install subj3ct
+
+==== Usage
+
+Query a specific subject - to be specific: its subject identity record -  using it's identifier:
+
+ Subj3ct.identifier("http://www.topicmapslab.de/publications/TMRA_2009_subj3ct_a_subject_identity_resolution_service")
+
+See the README or the github page for more examples.
+
+==== Subj3ct vs. Subject
+
+The official name is "Subj3ct", however in this API, you can also use "Subject" which may be easier to remember or to type for normal, n0n-1337 people. It should work for the gem, for the require and for the main module.
+
+==== Contribute!
+
+Subj3ct is a young and ambitious service. It's free, will stay free and needs your help. Contribute to this library! Create bindings for other languages! Publish your data as linked data to the web and register it with subj3ct.com.
+
+==== Note on Patches/Pull Requests
+ 
+ * Fork the project on http://github.bb/subj3ct
+ * Make your feature addition or bug fix.
+ * Add tests for it. This is important so I don't break it in a future version unintentionally.
+ * Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+ * Send me a pull request. Bonus points for topic branches.
+
+==== Copyright
+
+Copyright (c) 2010 Benjamin Bock, Topic Maps Lab. See LICENSE for details.
+}
+  s.email = %q{bb--github.com@bock.be}
+  s.extra_rdoc_files = [
+    "LICENSE", "README.markdown"
+  ]
+  
+  s.homepage = %q{http://github.com/bb/subj3ct}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Ruby bindings for Subj3ct.com, the DNS for the semantic web.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<yard>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<yard>, [">= 0"])
+  end
+  s.add_dependency(%q<subj3ct>, [">= 0.0.1"])
+end
+

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: subj3ct
 version: !ruby/object:Gem::Version 
-  hash: 29
   prerelease: false
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Benjamin Bock
@@ -15,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-15 00:00:00 +02:00
+date: 2010-06-21 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,7 +25,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 13
         segments: 
         - 1
         - 2
@@ -42,7 +40,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
@@ -118,6 +115,8 @@ files:
 - spec/spec.opts
 - spec/spec_helper.rb
 - spec/subj3ct_spec.rb
+- subj3ct.gemspec
+- subject.gemspec
 has_rdoc: true
 homepage: http://github.com/bb/subj3ct
 licenses: []
@@ -132,7 +131,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -141,7 +139,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"