rzotero 0.0.2

data/.gitignore

@@ -0,0 +1,7 @@
+pkg
+.DS_Store
+log
+doc
+rZotero-*.gem
+rdoc
+*.gemspec

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2010 Wayne Graham
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.rdoc

@@ -0,0 +1,39 @@
+= rzotero
+
+A simple, extensible Ruby client for the Zotero API.
+
+== Installation
+  gem install rzotero
+
+== Dependencies
+rzotero uses the Nokogiri gem to parse the RSS feed from Zotero
+
+== Usage
+
+The Zotero API currently requires your user ID (not your user name) to properly construct the API call. If you need to look up your user id, head over to {Zotero ID Finder}[http://zotero-id-finder.heroku.com/]
+
+  require 'rubygems'
+  require 'rzotero'
+
+  zotero = RZotero.new(1, 'api_key')
+
+  puts zotero.user
+  puts zotero.key
+  puts zotero.items
+  puts zotero.item(2)
+  puts zotero.collections
+  puts zotero.collection(1)
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* 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 Wayne Graham. See link:LICENSE for details.

data/Rakefile

@@ -0,0 +1,51 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+     gem.name = "rzotero"
+      gem.summary = %Q{A Ruby client for the Zotero API}
+      gem.description = %Q{rZotero provides a simple and extensible library for working with the Zotero API}
+      gem.email = "wayne.graham@gmail.com"
+      gem.homepage = "http://github.com/waynegraham/rzotero"
+      gem.authors = ["Wayne Graham"]
+      
+      # gem dependencies
+      gem.add_dependency "nokogiri", ">= 1.4.0"
+      
+      # dev dependencies
+      gem.add_development_dependency "rspec", ">= 1.2.9"
+      gem.add_development_dependency "fakeweb", ">= 1.2.8"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rzotero #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/examples/test.rb

@@ -0,0 +1,16 @@
+require 'rubygems'
+require 'rzotero'
+# require 'open-uri'
+# require 'nokogiri'
+ 
+
+zotero = RZotero.new(43, 'SqbbheQDVlJQUgd9NQVgnUjT')
+
+puts zotero.user
+puts zotero.key
+
+puts zotero.items
+puts zotero.item(11944)
+puts zotero.collections
+puts zotero.collection(276)
+ 

data/lib/rzotero.rb

@@ -0,0 +1,79 @@
+require 'rubygems'
+require 'open-uri'
+require 'nokogiri'
+  
+class RZotero
+     
+  BASE_URL = 'https://api.zotero.org'
+  
+  attr_accessor :rzotero_error
+  
+  def initialize(user_id, api_key)
+    @rzotero_error = false
+    begin
+       #TODO need to check if the user_id is numeric; 
+      raise TypeError, "user_id must be an Integer" unless user_id.kind_of? Integer
+      raise TypeError, "api_key must be a String" unless api_key.kind_of? String
+  
+      @user_id = user_id
+      @api_key = api_key
+    rescue TypeError
+      @rzotero_error = true
+    end
+  end
+  
+  def key
+    return @api_key
+  end
+  
+  # def key!(api_key)
+  #    raise TypeError, "api_key must be a String" unless user_id.kind_of? String
+  #    @api_key = api_key
+  #  end
+  
+  def user
+    return @user_id
+  end
+  
+  # def user!(user_id)
+  #     raise TypeError, "user_id must be an Integer" unless user_id.kind_of? Integer
+  #     @user_id = user_id
+  #   end
+  
+  def base
+    return BASE_URL
+  end
+  
+  # Returns all items for the user
+  def items 
+    url = "#{BASE_URL}/users/#{@user_id}/items?key=#{@api_key}"
+    return Nokogiri.parse(open(url))
+  end
+  
+  # Returns a specific item
+  def item(id)
+    url = "#{BASE_URL}/users/#{@user_id}/items/#{id}?key=#{@api_key}"
+    return Nokogiri.parse(open(url))
+  end
+
+  def item_children(id)
+    url = "#{BASE_URL}/users/#{@user_id}/items/#{id}/children?key=#{@api_key}"
+    return Nokogiri.parse(open(url))
+  end
+
+  def collections 
+    url = "#{BASE_URL}/users/#{@user_id}/collections?key=#{@api_key}"
+    return Nokogiri.parse(open(url))
+  end
+
+  def collection(id)
+    url = "#{BASE_URL}/users/#{@user_id}/collections/#{id}?key=#{@api_key}"
+    return Nokogiri.parse(open(url))
+  end
+
+  # def user_id
+  #     url = "#{OLD_BASE_URL}/users/#{USER}"
+  #     doc = Nokogiri.parse(open(url)).xpath("//id")
+  #     return doc.to_s[/[0-9]+/]
+  #   end
+end

data/spec/rzotero_spec.rb

@@ -0,0 +1,35 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "RZotero" do
+  
+  before(:each) do
+    @user_id = 43
+    @api_key = 'test'
+    @zotero = RZotero.new(@user_id, @api_key)
+  end
+  
+  it "should not be valid with a String user_id" do
+    @zotero = RZotero.new("43", "test")
+    @zotero.rzotero_error.should be_true
+    @zotero.should raise_error
+  end
+  
+  it "should not be valid with an Integer api_key" do
+    @zotero = RZotero.new("test", 43)
+    @zotero.rzotero_error.should be_true
+    @zotero.should raise_error 
+  end
+  
+  it "should get the correct key ('test')" do
+    @zotero.key.should eql(@api_key)
+  end
+  
+  it "should get the correct user_id ('43')" do
+    @zotero.user.should eql(@user_id)
+  end
+  
+  it "shuold get the correct BASE_URL" do
+    @zotero.base.should eql('https://api.zotero.org')
+  end
+  
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rzotero'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification 
+name: rzotero
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Wayne Graham
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-14 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 4
+        - 0
+        version: 1.4.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: fakeweb
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 8
+        version: 1.2.8
+  type: :development
+  version_requirements: *id003
+description: rZotero provides a simple and extensible library for working with the Zotero API
+email: wayne.graham@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/rzotero.rb
+- spec/rzotero_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/waynegraham/rzotero
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A Ruby client for the Zotero API
+test_files: 
+- spec/rzotero_spec.rb
+- spec/spec_helper.rb
+- examples/test.rb