spruce 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2010 Peter Hellberg
+
+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,69 @@
+= Spruce ↟
+
+Spruce is a Ruby wrapper around the {Forrst API}[http://forrst.com/apidocs.html]. 
+The Forrst API is currently a <em>moving target</em> and the plan is to develop Spruce 
+alongside it, as close as possible. Spruce will support authentication via API tokens.
+
+== Installation
+
+    gem install spruce
+
+== Dependencies
+
+The {YAJL C Bindings for Ruby}[http://github.com/brianmario/yajl-ruby] are so 
+full of *AWESOME* that it is almost impossible to not use them everywhere JSON 
+is involved, so I didn’t.
+
+I’m also temporarily using the {REST Client}[http://github.com/archiloque/rest-client]
+gem until the Forrst API returns the correct MIME type and status codes.
+
+== Getting started
+
+    require 'rubygems'
+    require 'forrst' # or require 'spruce'
+    
+    # Retrieve a user by username
+    kyle = Forrst::User.find 'kyle'
+      
+    # Kyles latest PUBLIC posts
+    kyle.public_posts
+    
+    # The type of Kyles latest PUBLIC post
+    kyle.public_posts[0].post_type
+    
+    # Kyles PUBLIC posts before post_id 5000
+    kyle.public_posts_before(5000)
+    
+    # Retrieve a user by id
+    peter = Forrst::User.find 5079
+
+== Links
+
+* {Forrst API}[http://forrst.com/apidocs.html]
+* {YAJL C Bindings for Ruby}[http://github.com/brianmario/yajl-ruby]
+
+== TODO
+
+Implement the different post types by subclassing *Forrst::Post*
+
+== LICENCE
+
+Copyright (c) 2010 Peter Hellberg
+
+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/Rakefile

@@ -0,0 +1,21 @@
+require 'rubygems'
+gem 'rdoc' # Required on Mac OS X to get a “working” rdoc version
+require 'rake/rdoctask'
+
+desc 'Generate RDoc documentation for the spruce gem.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_files.include('README.rdoc').
+    include('lib/**/*.rb').
+    exclude('lib/leaf/finders/sequel.rb').
+    exclude('lib/leaf/view_helpers/sinatra.rb').
+    exclude('lib/leaf/core_ext.rb').
+    exclude('lib/leaf/version.rb')
+  
+  rdoc.main = "README.rdoc" # page to start on
+  rdoc.title = "leaf documentation"
+  
+  rdoc.rdoc_dir = 'doc' # rdoc output folder
+  rdoc.options << '--inline-source' << '--charset=UTF-8' << '--format=darkfish'
+  rdoc.options << '--main=README.rdoc'
+  rdoc.options << '--webcvs=http://github.com/c7/spruce/tree/master/'
+end

data/lib/forrst.rb

@@ -0,0 +1,36 @@
+require 'spruce'
+
+module Forrst
+  API_URI     = "http://api.forrst.com/api/"
+  API_VERSION = 'v1'
+  
+  ## Sections of the Forrst API
+  require 'forrst/user'
+  
+  ## Exceptions
+  module Exceptions
+    class InvalidUserId < ArgumentError
+      def to_s
+        'Invalid User ID, must be an Integer'
+      end
+    end
+    
+    class InvalidPostId < ArgumentError
+      def to_s
+        'Invalid Post ID, must be an Integer'
+      end
+    end
+    
+    class InvalidUsername < ArgumentError
+      def to_s
+        'Invalid username, must be a String'
+      end
+    end
+    
+    class UserNotFound < ArgumentError
+      def to_s
+        'User not found on Forrst'
+      end
+    end
+  end
+end

data/lib/forrst/list_of_posts.rb

@@ -0,0 +1,11 @@
+require 'forrst/post'
+
+module Forrst
+  class ListOfPosts < Array
+    attr_accessor :status, :raw_data
+    
+    def add_post(post)
+      self << post
+    end
+  end
+end

data/lib/forrst/post.rb

@@ -0,0 +1,50 @@
+require 'time'
+
+module Forrst
+  class Post
+    attr_accessor :raw_data
+    
+    def initialize(data)
+      populate(data)
+    end
+    
+    def populate(data)
+      # Save the raw data hash
+      @raw_data = data
+      
+      # Standard fields
+      standard_fields = [
+        'slug', 'tag_string', 'tiny_id', 'faved_by_current_user', 'title',
+        'markdown_description', 'markdown_content', 'reply_key', 'reply_url', 
+        'current_user_likes_this', 'url', 'url_with_wbr', 'post_type', 
+        'in_reply_to_post_id', 'post_url', 'phrase', 'formatted_description',
+        'tag_objs', 'tags', 'images', 'snap_content_type',
+      ]
+      
+      # Numeric fields such as like count and number of views
+      numeric_fields = [
+        'like_count', 'views', 'is_public', 'id', 'comment_count', 
+        'short_url_redirects', 'user_id', 'snap_file_size'
+      ]
+      
+      # Date fields
+      date_fields = [
+        'created_at', 'updated_at', 'snap_updated_at'
+      ]
+      
+      standard_fields.map { |f| instance_variable_set("@#{f}", data[f]) }
+      numeric_fields.map  { |f| instance_variable_set("@#{f}", data[f].to_i) }
+      date_fields.map     { |f| instance_variable_set("@#{f}", f.match(/\d\d\d\d/) ? Time.parse(data[f]) : nil) }
+      
+      # Define accessor methods
+      (class << self; self; end).class_eval do
+        # Handle the standard fields
+        (standard_fields + numeric_fields + date_fields).each do |field|
+          define_method "#{field}" do
+            instance_variable_get("@#{field}")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/forrst/user.rb

@@ -0,0 +1,53 @@
+require 'uri'
+require 'yajl'
+require 'rest_client'
+
+require 'forrst/user/public_posts'
+
+module Forrst
+  class User
+    INFO_RESOURCE = "#{API_URI}#{API_VERSION}/users/info"
+    
+    attr_reader :username, :id, :raw_data
+    
+    def self.find(id)
+      (id.is_a? Fixnum) ? self.find_by_user_id(id) : self.find_by_username(id)
+    end
+    
+    def initialize(uri)
+      begin
+        response = RestClient.get uri
+        
+        if response.code == 200
+          @raw_data = Yajl::Parser.parse(response.body)['resp']['user']
+          @username = @raw_data['username']
+          @id = @raw_data['id'].to_i # Should be a Fixnum from the start
+        end
+        
+      rescue RestClient::ResourceNotFound
+        raise Exceptions::UserNotFound
+      end
+    end
+    
+    def public_posts
+      @posts ||= PublicPosts.new(username)
+      @posts.latest
+    end
+    
+    def public_posts_before(post_id)
+      @posts ||= PublicPosts.new(username)
+      @posts.before(post_id)
+    end
+    
+  private
+    def self.find_by_user_id(user_id)
+      raise Exceptions::InvalidId unless user_id.is_a? Fixnum
+      self.new("#{INFO_RESOURCE}?id=#{user_id}")
+    end
+    
+    def self.find_by_username(username)
+      raise Exceptions::InvalidUsername unless username.is_a? String
+      self.new("#{INFO_RESOURCE}?username=#{username}")
+    end
+  end
+end

data/lib/forrst/user/public_posts.rb

@@ -0,0 +1,51 @@
+require 'forrst/list_of_posts'
+
+module Forrst
+  class User
+    class PublicPosts
+      RESOURCE = "#{API_URI}#{API_VERSION}/users/posts"
+      
+      def latest
+        return @posts unless @posts.nil?
+        response = get("#{RESOURCE}?username=#{@username}")
+        
+        @posts = ListOfPosts.new
+        response['resp']['posts'].map { |p| 
+          @posts.add_post(Forrst::Post.new(p)) 
+        }
+        @posts.status = response['resp']['stat']
+        @posts.raw_data = response
+        
+        @posts
+      end
+      
+      def before(post_id)
+        raise Exceptions::InvalidPostId unless post_id.is_a? Fixnum
+        response = get("#{RESOURCE}?username=#{@username}&last_id=#{post_id}")
+        
+        posts = ListOfPosts.new
+        response['resp']['posts'].map { |p| 
+          posts.add_post(Forrst::Post.new(p))
+        }
+        posts.status = response['resp']['stat']
+        posts.raw_data = response
+        
+        posts
+      end
+      
+      def initialize(username)
+        raise Exceptions::InvalidUsername unless username.is_a? String
+        @username = username
+      end
+    private
+      def get(uri)
+        begin
+          response = RestClient.get uri
+          Yajl::Parser.parse(response.body) if response.code == 200
+        rescue RestClient::ResourceNotFound
+          raise Exceptions::UserNotFound
+        end
+      end
+    end
+  end
+end

data/lib/spruce.rb

@@ -0,0 +1,9 @@
+# = Spruce - a Ruby wrapper around the Forrst API
+#
+# Happy Forrsting!
+
+require 'forrst'
+
+module Spruce
+  require 'spruce/version'
+end

data/lib/spruce/version.rb

@@ -0,0 +1,9 @@
+module Spruce
+  module VERSION
+    MAJOR = 0
+    MINOR = 0
+    TINY  = 1
+    
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification 
+name: spruce
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Peter Hellberg
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-26 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: yajl-ruby
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 0
+        - 7
+        - 7
+        version: 0.7.7
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 6
+        - 0
+        version: 1.6.0
+  type: :runtime
+  version_requirements: *id002
+description: Spruce is a Ruby wrapper around the Forrst API. The Forrst API is currently a _moving target_ and the plan is to develop Spruce alongside it, as close as possible.
+email: peter@c7.se
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- MIT-LICENSE
+files: 
+- lib/forrst/list_of_posts.rb
+- lib/forrst/post.rb
+- lib/forrst/user/public_posts.rb
+- lib/forrst/user.rb
+- lib/forrst.rb
+- lib/spruce/version.rb
+- lib/spruce.rb
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+has_rdoc: true
+homepage: http://c7.github.com/spruce
+licenses: 
+- MIT-LICENSE
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+- --charset=UTF-8
+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: spruce
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Spruce is a Ruby wrapper around the Forrst API
+test_files: []
+