ideaoforder-goodreads 0.1.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Mark Dickson
+
+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.

data/README.rdoc

@@ -0,0 +1,27 @@
+= goodreads
+
+This gem allows you to connect to your goodreads bookshelves and reviews. Currently, no write write operations are supported--it's just meant to grab your books/reviews to display them on your website/blog. It is in no way meant to be exhaustive--fork away!
+ 
+== Configuration
+You'll need a goodreads.yml file in config, with:
+	:user_id:
+and optionally
+	:api_key:
+which you'll have to apply for. The developer key allows you to perform actions which require authentication, none of which are currently used in this plugin. If you'd like more functionality, check out: http://www.goodreads.com/api and fork the project.
+
+Cheers!
+
+== 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) 2009 Mark Dickson. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,60 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "goodreads"
+    gem.summary = "Uses the Goodreads API to grab your book reviews"
+    gem.description = "Uses the Goodreads API to grab your book reviews. Takes all the standard Goodreads arguments. This gem is currently just a baby, and will may include more features over time. For now, it's mainly meant to allow folks to show their books and reviews on a website/blog."
+    gem.email = "mark@sitesteaders.com"
+    gem.homepage = "http://github.com/ideaoforder/goodreads"
+    gem.authors = ["Mark Dickson"]
+    gem.add_dependency('httparty', '>= 0.4.4')
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "goodreads #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/goodreads.gemspec

@@ -0,0 +1,51 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{goodreads}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Mark Dickson"]
+  s.date = %q{2009-08-11}
+  s.description = %q{Uses the Goodreads API to grab your book reviews. Takes all the standard Goodreads arguments. This gem is currently just a baby, and will may include more features over time. For now, it's mainly meant to allow folks to show their books and reviews on a website/blog.}
+  s.email = %q{mark@sitesteaders.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "goodreads.gemspec",
+     "lib/goodreads.rb",
+     "test/goodreads_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/ideaoforder/goodreads}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Uses the Goodreads API to grab your book reviews}
+  s.test_files = [
+    "test/goodreads_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<httparty>, [">= 0.4.4"])
+    else
+      s.add_dependency(%q<httparty>, [">= 0.4.4"])
+    end
+  else
+    s.add_dependency(%q<httparty>, [">= 0.4.4"])
+  end
+end

data/lib/goodreads.rb

@@ -0,0 +1,65 @@
+require 'rubygems'
+require 'httparty'
+
+module Goodreads
+  include HTTParty
+  
+  @defaults = YAML::load(File.open("#{RAILS_ROOT}/config/goodreads.yml")) if File.exist? "#{RAILS_ROOT}/config/goodreads.yml" 
+  base_uri 'http://www.goodreads.com'
+  default_params :key => @defaults[:api_key] if (@defaults and @defaults[:api_key])
+  format :xml
+
+  @@user_id = @defaults[:user_id] if (@defaults and @defaults[:user_id])
+
+  # page:  1
+  # per_page: 1-200
+  # shelf:  read, currently-reading, to-read, etc
+  # key: Needed for private profiles. Different from developer key, and is unique to each member. Obtained from the member's rss link on the "my books page" or the lookup via email method.
+  # order: a, d
+  # sort: position, votes, rating, shelves, avg_rating, isbn, comments, author, title, notes, cover, review, random, date_read, year_pub, date_added, num_ratings, date_updated
+  def self.reviews(opts={})
+    defaults = {:page => 1, :per_page => 10, :shelf => 'read', :sort => 'date_read', :order => 'd'}
+    opts = defaults.merge(opts)
+    user_id = opts[:user_id] || @@user_id
+    opts.delete(:user_id)
+    result = self.get("/review/list_rss/#{user_id}", :query => opts)
+    result["rss"]["channel"]["item"].map { |data| Goodreads::Review.new(data) }
+    # now...what to do with these...
+  end
+  
+  class Review
+    attr_accessor :book_small_image_url, 
+                  :user_date_created, 
+                  :user_shelves, 
+                  :average_rating, 
+                  :book_image_url, 
+                  :book_medium_image_url, 
+                  :user_read_at, 
+                  :guid, 
+                  :pubDate, 
+                  :title, 
+                  :author_name, 
+                  :isbn, 
+                  :book_published,
+                  :user_review,
+                  :user_name,
+                  :user_date_added,
+                  :link,
+                  :book_id,
+                  :book_description,
+                  :description,
+                  :book,
+                  :book_large_image_url,
+                  :user_rating
+    def initialize(data)
+      data.each do |k, v|
+        if v and v.is_a? String
+          val = v.gsub(/\n/, '').gsub(/\t/, '').strip 
+        else
+          val = v
+        end
+        send(:"#{k}=", val)
+      end
+    end
+  end
+end

data/test/goodreads_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class GoodreadsTest < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'goodreads'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: ideaoforder-goodreads
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Mark Dickson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-11 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.4.4
+    version: 
+description: Uses the Goodreads API to grab your book reviews. Takes all the standard Goodreads arguments. This gem is currently just a baby, and will may include more features over time. For now, it's mainly meant to allow folks to show their books and reviews on a website/blog.
+email: mark@sitesteaders.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- goodreads.gemspec
+- lib/goodreads.rb
+- test/goodreads_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/ideaoforder/goodreads
+licenses: 
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 2
+summary: Uses the Goodreads API to grab your book reviews
+test_files: 
+- test/goodreads_test.rb
+- test/test_helper.rb