posterous 0.2.1 → 0.2.2

data/README.md

@@ -1,31 +1,156 @@
 # Posterous #
 
+## Dependencies ##
+
+  Typhoeus [https://github.com/dbalatero/typhoeus](https://github.com/dbalatero/typhoeus)
+
 ## Installation ##
 
     gem install posterous
+
+## Rails ##
+
+  In you Gemfile:
+  
+    gem 'posterous'
+
+  Create `config/initializers/posterous.rb`.
+
+```ruby
+Posterous.config = {
+  'username'  => '<username>',
+  'password'  => '<password>',
+  'api_token' => '<api_token>'
+}
+```
     
-## Basic Usage ##
-    
-    require 'posterous'
-    
-    Posterous.config = {
-      'username' => <username>,
-      'password' => <password>,
-      'api_token' => '<api_token>'
-    }
-    
-    include Posterous
+## Elsewhere ##
     
-    ### Sites ###
-    p Site.all
-    p Site.primary
-    p Site.find('twoism')
+```ruby
+require 'posterous'
+
+Posterous.config = {
+  'username'  => '<username>',
+  'password'  => '<password>',
+  'api_token' => '<api_token>'
+}
+
+include Posterous
+```
+
+
+## API ##
+
+## User ##
+
+  **Current user info**
+  
+    > User.me
+    => <#<Posterous::User:0x00000100cacbe0> {:last_activity=>"2011/04/25 20:33:50 -0700",
+    :nickname=>"postertester", :lastname=>nil, :id=>1288737, :firstname=>nil, 
+    :profile_pic=>"http://posterous.com/images/profile/unknown75.gif"}>
+  
+  **Favorites**
+
+    > @user = User.me
+    > @user.favorites(:page => 1)
+    => [<#<Posterous::Post:0x00000100c2c7b0>...] 
+
+  **Subscriptions**
+
+    > @user = User.me
+    > @user.subscriptions(:page => 1)
+    => [<#<Posterous::Site:0x00000100c2c7b0>...] 
+
+  **Subscription Posts**
+
+    > @user = User.me
+    > @user.subscriptions.posts(:page => 1)
+    => [<#<Posterous::Post:0x00000100c2c7b0>...] 
+
+## Sites ##
+
+  **Find a primary site**
+  
+    > Site.primary
+    => <#<Posterous::Site:0x00000100c22490> {:header_image=>nil, :name=>"postertester's posterous" ... }>
     
-    ### Posts ###
-    p Site.primary.posts
-    p Site.primary.posts.create(:title => 'New Post', :body => 'From posterous API', :media => [File.open('/path/to/file')])
+  **Find a Site by its hostname**
+
+    > Site.find('twoism')
+    => <#<Posterous::Site:0x00000100c22490> {:header_image=>nil, :name=>"postertester's posterous" ... }>
+
+  **Find all of the current user's Sites**
+
+    > Site.all(:page => 1)
+    => [<#<Posterous::Site:0x00000100c22490> {:header_image=>nil, :name=>"postertester's posterous" ... }>]
+
+  **Creating a new Site**
 
+    > @site = Site.create(:hostname => 'superawesome',:is_private => false)
+    => <#<Posterous::Site:0x00000100c22490> {:header_image=>nil, :name=>"superawesome's posterous" ... }>
+
+  **Updating a Site**
     
+    > @site = Site.primary
+    => @site.hostname = 'anotherawesomesite'
+    => @site.save
+
+  **Deleting a Site**
+
+    > @site = Site.find('sitetodelete')
+    => @site.destroy
+
+
+## Posts ##
+
+  **Creating Posts**
+
+    > @site = Site.primary
+    > @post = @site.posts.create(:title => 'New Post', :body => 'From posterous API', 
+    :media => [File.open('/path/to/file')], :autopost => true)
+    => <#<Posterous::Post:0x00000100c2c7b0>
+
+  **Updating Posts**
+  
+    > @post = @site.posts.find(<id>)
+    > @post.title = 'Kittens are radical!'
+    > @post.save
+
+  **Deleting Posts**
+  
+    > @post = @site.posts.find(<id>)
+    > @post.destroy
+
+  **Retrieving Posts**
+
+    # paginated
+    > @site.posts(:page => 1)
+
+    # paginated since a given id
+    > @site.posts(:page => 3, :since_id => 123)
+
+## Commenting ##
+
+    > @site = Site.find('someawesomesite')
+    > @site.posts.first.comments.create(:body => "Yes, kittens are very
+    > radical")
+
+## Liking ##
+
+    > @site = Site.find('someawesomesite')
+    > @site.posts.first.likes.create
+
+## Subscribers ##
+
+    > @site = Site.find('someawesomesite')
+    > @site.subscribers(:page => 1)
+
+## External Sites / Autopost ##
+
+    > @site.external_sites(:page => 1)
+    => [<#<Posterous::ExternalSite:0x00000100c2c7b0>]
+
 ## Interactive Console Usage ##
 
   In your terminal type...
@@ -62,4 +187,4 @@
      => <#<Posterous::Post:0x00000101398670> 
     > post.comments.create(:body => 'Kittens are radical!')
     => <#<Posterous::Comment:0x0000010135f758> ... }>
-    
+    

data/bin/posterous

@@ -37,12 +37,8 @@ $:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
 
 %w{posterous irb}.each { |f| require f }
 
-if File.exists?(RC_PATH)
-  rc = File.open(RC_PATH, 'r')
-  yml = YAML.load_file(RC_PATH)
-else
-  rc = File.open(RC_PATH, 'w')
-end
+rc  = File.exists?(RC_PATH) ? File.open(RC_PATH, 'r') : File.open(RC_PATH, 'w')
+yml = YAML.load_file(RC_PATH)
 
 if yml.is_a?(Hash)
   cfg = yml
@@ -50,22 +46,32 @@ else
   cfg = {}
   puts "Email Address:"
   cfg['username'] = gets.chomp
-  puts "Password:"
-  cfg['password'] = gets.chomp
+  begin
+    puts "Password:"
+    system('stty -echo')
+    cfg['password'] = gets.chomp
+  rescue
+  ensure
+    system('stty echo')
+  end
   puts "Api Token:"
   cfg['api_token'] = gets.chomp
   rc.puts cfg.to_yaml
 end
 
+rc.puts cfg.to_yaml
 rc.close
 
 Posterous.config = cfg
 
 include Posterous
 
-@user = User.me
+def current_user
+  @current_user ||= User.me
+end
+
 puts "*"*100
-puts "Hi #{@user.nickname}, welcome to the Posterous API Console! For help type `newb`.\n"
+puts "Hi #{current_user.nickname}, welcome to the Posterous API Console! For help type `newb`.\n"
 puts "*"*100
 
 IRB.setup(nil)

data/lib/posterous.rb

@@ -1,28 +1,5 @@
 %w[typhoeus yaml json ostruct].each { |lib| require lib }
 
-require 'pathname'
-
-dir = Pathname(__FILE__).dirname.expand_path
-
-require dir + 'posterous/connection'
-require dir + 'posterous/inheritable'
-require dir + 'posterous/model'
-require dir + 'posterous/models/tag'
-require dir + 'posterous/models/subscriber'
-require dir + 'posterous/models/subscription'
-require dir + 'posterous/models/comment'
-require dir + 'posterous/models/like'
-require dir + 'posterous/models/post'
-require dir + 'posterous/models/page'
-require dir + 'posterous/models/link'
-require dir + 'posterous/models/link_category'
-require dir + 'posterous/models/external_site'
-require dir + 'posterous/models/user'
-require dir + 'posterous/models/profile'
-require dir + 'posterous/models/site'
-require dir + 'posterous/association_proxy'
-
-
 module Posterous
   BASE_API_URL = 'http://posterous.com/api/v2'
 

data/lib/posterous/association_proxy.rb

@@ -9,7 +9,7 @@ module Posterous
       @proxied            = proxied
       @association        = nil
 
-      @association_klass.finder_opts[klass.parent_resource] = proxied.id
+      @association_klass.finder_opts[klass.resource_url_keys.last] = proxied.id
       @association_klass.finder_opts.merge!(@proxied.finder_opts)
 
       load_method   =  association_type == :many ? :all : :load

data/lib/posterous/inheritable.rb

@@ -6,7 +6,7 @@ module Posterous
         extend ClassMethods
         include InstanceMethods
 
-        inherited_attributes :finder_opts, :parent_resource, :resource_path
+        inherited_attributes :finder_opts, :resource_path
         @finder_opts ||= {} 
       end  
     end
@@ -34,32 +34,12 @@ module Posterous
         @resource_path = path
       end
 
-      def parent sym
-        @parent_resource = sym
-      end
-
-      def many collection_name, klass
-        define_method collection_name do |*args|
-          AssociationProxy.new self, klass, :many, *args
-        end
-      end
-
-      def one collection_name, klass
-        define_method collection_name do |*args|
-          AssociationProxy.new self, klass, :one, *args
-        end
-      end
-
     end
 
     module InstanceMethods
       def resource_path
         self.class.resource_path
       end
-
-      def parent_resource
-        self.class.parent_resource
-      end
       
       def finder_opts
         self.class.finder_opts

data/lib/posterous/model.rb

@@ -4,6 +4,18 @@ module Posterous
     extend Connection
     
     attr_reader :struct
+
+    def self.many collection_name, klass
+      define_method collection_name do |*args|
+        AssociationProxy.new self, klass, :many, *args
+      end
+    end
+
+    def self.one collection_name, klass
+      define_method collection_name do |*args|
+        AssociationProxy.new self, klass, :one, *args
+      end
+    end
     
     # hack for ruby 1.8.7 
     def id
@@ -87,6 +99,10 @@ module Posterous
     def parsed_resource_url
       self.class.parsed_resource_url     
     end
+
+    def self.resource_url_keys
+      resource_path.scan(/:(\w+)/).flatten.collect(&:to_sym)
+    end
         
     def initialize struct
       @struct = struct

data/lib/posterous/models/comment.rb

@@ -1,6 +1,5 @@
 module Posterous
   class Comment < Posterous::Model
-    parent    :post_id
     resource  "/sites/:site_id/posts/:post_id/comments"
   end
 end

data/lib/posterous/models/external_site.rb

@@ -1,6 +1,5 @@
 module Posterous
   class ExternalSite < Posterous::Model
-    parent    :site_id
     resource  "/sites/:site_id/external_sites"
   end
 end

data/lib/posterous/models/like.rb

@@ -1,6 +1,5 @@
 module Posterous
   class Like < Posterous::Model
-    parent    :post_id
     resource  "/sites/:site_id/posts/:post_id/likes"
   end
 end

data/lib/posterous/models/link.rb

@@ -1,6 +1,5 @@
 module Posterous
   class Link < Posterous::Model
-    parent    :link_category_id
     resource  "/sites/:site_id/link_categories/:link_category_id/links"
   end
 end

data/lib/posterous/models/link_category.rb

@@ -1,6 +1,5 @@
 module Posterous
   class LinkCategory < Posterous::Model
-    parent    :site_id
     resource  "/sites/:site_id/link_categories"
 
     many :links, Link

data/lib/posterous/models/page.rb

@@ -1,6 +1,5 @@
 module Posterous
   class Page < Posterous::Model
-    parent    :site_id
     resource  "/sites/:site_id/pages"
   end
 end

data/lib/posterous/models/post.rb

@@ -1,6 +1,5 @@
 module Posterous
   class Post < Posterous::Model
-    parent    :site_id
     resource  "/sites/:site_id/posts"
 
     many      :comments, Comment

data/lib/posterous/models/profile.rb

@@ -1,6 +1,5 @@
 module Posterous
   class Profile < Posterous::Model
-    parent    :site_id
     resource  "/sites/:site_id/profile"
 
     def self.param_scope

data/lib/posterous/models/subscriber.rb

@@ -1,6 +1,5 @@
 module Posterous
   class Subscriber < Posterous::Model
-    parent    :site_id
     resource  "/sites/:site_id/subscribers"
   end
 end

data/lib/posterous/models/subscription.rb

@@ -1,6 +1,5 @@
 module Posterous
   class Subscription < Posterous::Model
-    parent    :user_id
     resource  "/users/:user_id/subscriptions"
 
     def self.posts params={}

data/lib/posterous/models/tag.rb

@@ -1,6 +1,5 @@
 module Posterous
   class Tag < Posterous::Model
-    parent    :site_id
     resource  "/sites/:site_id/tags"
   end
 end

data/lib/posterous/version.rb

@@ -1,3 +1,3 @@
 module Posterous
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 1
-  version: 0.2.1
+  - 2
+  version: 0.2.2
 platform: ruby
 authors: 
 - Christopher Burnett @twoism
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-25 00:00:00 -07:00
+date: 2011-04-26 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency