mendeley 0.0.2

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in mendeley.gemspec
+gemspec

data/Rakefile

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

data/lib/mendeley.rb

@@ -0,0 +1,10 @@
+require 'yajl/json_gem'
+require 'uri'
+require 'rest-client'
+require 'mendeley/public_api'
+module Mendeley
+  #Setup the consumer_key that will be used for all public api requests
+  class << self
+    attr_accessor :consumer_key
+  end
+end

data/lib/mendeley/public_api.rb

@@ -0,0 +1,52 @@
+module Mendeley
+  module API
+    def request(sub_url, params = nil)
+      request = build_request_url(sub_url ,params)
+      JSON.parse(RestClient.get(request))
+    end
+
+    def build_request_url(sub_url, params = nil )
+      request_url = File.join(self.base_url, sub_url)
+      param_string = "?consumer_key=#{Mendeley.consumer_key}"
+      if params
+        params.each do |key,value|
+          param_string << "&#{key}=#{value}"
+        end
+      end
+      request_url.concat(param_string)
+    end
+    private :build_request_url
+    
+    #Wrapper for the public /documents/ domain on mendeley
+    #see http://apidocs.mendeley.com/home/public-resources
+    #All of the following actions will take place on the 
+    #documents namespace of the API. 
+    #
+    #EX// to search all documents for "hello world" you would do 
+    #       Mendeley::API::Documents.search("hello world")
+    # All Responses will be a ruby hash created by parsing the 
+    # response json from the mendeley api
+    class Documents
+      extend API
+
+      @base_url = "http://api.mendeley.com/oapi/documents/"
+
+      def self.base_url
+        @base_url
+      end
+
+      #Search all documents using the public API for the given term
+      def self.search(term)
+        request(File.join("search", URI.escape(term)))
+      end
+
+      #Fetch the detailed description of the document from mendeley
+      def self.document_details(doc_id)
+        unless doc_id.is_a?(String)
+          raise "Invalid argument type. Must be a string"
+        end
+        request(File.join("details", URI.escape(doc_id)))
+      end
+    end
+  end
+end

data/lib/mendeley/version.rb

@@ -0,0 +1,3 @@
+module Mendeley
+  VERSION = "0.0.2"
+end

data/mendeley.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "mendeley/version"
+
+Gem::Specification.new do |s|
+  s.name        = "mendeley"
+  s.version     = Mendeley::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Ryan Weald"]
+  s.email       = ["ryan@weald.com"]
+  s.homepage    = "http://github.com/rweald/mendeley"
+  s.summary     = %q{A simple ruby wrapper for the mendeley api}
+  s.description = %q{A simple ruby wrapper for the mendeley api}
+
+  s.rubyforge_project = "mendeley"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'mocha'
+  s.add_dependency 'rest-client'
+  s.add_dependency 'yajl-ruby'
+end

data/spec/mendeley/public_api_spec.rb

@@ -0,0 +1,45 @@
+require "spec_helper"
+include Mendeley::API
+
+describe "Mendeley" do
+  describe "API" do
+    describe "Documents" do
+      it "should extend all the API module methods" do
+        Mendeley::API::Documents.singleton_methods.include?("request").should be_true
+      end
+      it "should have a base_url" do
+        Documents.base_url.should == "http://api.mendeley.com/oapi/documents/"
+      end
+      
+      describe ".build_request_url" do
+        it "should return /search/<terms>" do
+          Documents.send(:build_request_url, "/search").should == "http://api.mendeley.com/oapi/documents/search?consumer_key="
+        end
+      end
+
+      describe ".search" do
+        it "should search documents for the string for marcio" do
+          response = JSON.generate({:result => "success"})
+          RestClient.expects(:get).with() do |request| 
+            request.should == "http://api.mendeley.com/oapi/documents/search/marcio%20von%20muhlen?consumer_key="
+          end.returns(response)
+          Documents.search("marcio von muhlen")
+        end
+      end
+
+      describe ".document_details" do
+        it "should return the details of a document do" do
+          response = JSON.generate({:result => "success"})
+          RestClient.expects(:get).with() do |request| 
+            request.should == "http://api.mendeley.com/oapi/documents/details/15?consumer_key="
+          end.returns(response)
+          Documents.document_details("15")
+        end
+
+        it "should throw an exception if the id is not a string" do
+          lambda{Documents.document_details(15)}.should raise_error
+        end
+      end
+    end
+  end
+end

data/spec/mendeley_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe "Mendeley" do
+  it "should have a version" do
+    Mendeley::VERSION.should be
+  end
+
+  it "should have a API submodule" do
+    Mendeley.constants.include?("API")
+  end
+
+  it "should have a consumer key" do
+    Mendeley.singleton_methods.include?("consumer_key")
+  end
+
+  it "should have nil as the initial consumer key value" do
+    Mendeley.consumer_key.should be_nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require "bundler"
+Bundler.setup
+
+require "rspec"
+require "mocha"
+require 'mendeley'
+
+Rspec.configure do |config|
+  config.mock_with :mocha
+end

data/watchr.rb

@@ -0,0 +1,39 @@
+first_run = true
+def run_test_suite
+  puts ("rspec spec/")
+  result = %x[rspec spec/]
+  send_growl_notification(result)
+  puts result
+end
+
+def parse_results(result_string)
+  error = false
+  if result_hash = (result_string.match(/([1-9]+) example[s]*, ([0-9]+) failure[s]*/))
+    result_hash = result_hash.captures
+  else
+    error = true
+    result_hash = [0,0]
+  end
+  {:failures => result_hash[1], :number_tests => result_hash[0], :error => error}
+end
+
+def send_growl_notification(result_text)
+  result_hash = parse_results(result_text)
+  title = "Test Results"
+  unless result_hash[:error]
+    message = "#{result_hash[:number_tests]} examples, #{result_hash[:failures]} failures"
+  else
+    message = "An Error Occured in your code" 
+  end
+  system(%Q[growlnotify -t "#{title}" -m "#{message}"])
+end
+
+#watch the lib directory and if anything changes run the whole test suite
+watch('lib/(.*)\.rb'){ run_test_suite} 
+watch('spec/*') {run_test_suite}
+
+#run the full test suite when watchr is first run
+if first_run 
+  run_test_suite
+  first_run = false
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification 
+name: mendeley
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Ryan Weald
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-01 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: yajl-ruby
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
+description: A simple ruby wrapper for the mendeley api
+email: 
+- ryan@weald.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Rakefile
+- lib/mendeley.rb
+- lib/mendeley/public_api.rb
+- lib/mendeley/version.rb
+- mendeley.gemspec
+- spec/mendeley/public_api_spec.rb
+- spec/mendeley_spec.rb
+- spec/spec_helper.rb
+- watchr.rb
+has_rdoc: true
+homepage: http://github.com/rweald/mendeley
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: mendeley
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A simple ruby wrapper for the mendeley api
+test_files: 
+- spec/mendeley/public_api_spec.rb
+- spec/mendeley_spec.rb
+- spec/spec_helper.rb