glue 0.41.0 → 1.0.0

data/History.txt

@@ -0,0 +1,6 @@
+=== 1.0.0 / 2009-08-25
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,6 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/glue.rb
+test/test_glue.rb

data/README.txt

@@ -0,0 +1,130 @@
+= glue
+
+http://Glue.RubyForge.org
+
+http://GlueNow.com
+
+== DESCRIPTION:
+
+The Glue gem enables posting to GlueNow.com API service using an account subdomain, username, password. In this version you can add a post by providing a title, body, optional author name and optional private settings. You can also access some basic info about a users account and check if their account info is valid.
+
+You can also request public posts from an account using the same RSS that powers the many Glue feeds.
+
+== FEATURES/PROBLEMS:
+
+* To Add a new post Title & Body text must be included
+* Access info about an account with successful login:
+  * Email Address
+  * If they are an admin
+  * Thier Author Name
+* Can check if a subdomain is valid and belongs to an account
+* Read all public posts
+* This Gem is throughly tested
+* Adding & Reading posts Only at this time
+* You can't editor delete a posts yet
+* No way to verify if a post has accepted the author name yet
+
+
+== SYNOPSIS:
+
+---- Adding Posts ----
+
+1. Instantiate your account
+
+    * Provide the subdomain, username and password for http://Your-Account.GlueNow.com
+    
+        account = Glue::API.new( "your-account", "j-username", "j-password" )
+        
+2. Check if the account subdomain is valid
+  
+        account.valid_site?   
+        
+3. Get more info about the user's account
+    
+        response = account.user_info
+        
+        response #=> {"rsp"=>{"user"=>{"author"=>"Jordan Dobson","admin"=>"true","email"=>"jordandobson@gmail.com"},"stat"=>"ok"}}
+        
+4. Post your Content
+
+    * Both Title and Body are required - Set to a variable to check the response
+    
+        response = account.post("My Title", "My Body")
+        
+    * You can also choose to set the post as private and/or use the optional Author Name
+    * In this example we set false for not private and true to use the author name
+    
+        response = account.post("My Title", "My Body", false, true) 
+        
+
+5. Get a success or error hash back
+
+    * A Successful response would look like this
+    
+        response #=> {"rsp"=>{"post"=>{"title"=>"My Title","url"=>"http://bit.ly/sakIM","id"=>"14415","longurl"=>"http://jordandobson.com"},"stat"=>"ok"}}
+    
+    * A Error response would be empty like this
+    
+        response #=> {}
+
+---- Reading Posts ----
+        
+1. Instantiate your Reader with your account info
+
+    * Provide the subdomain for http://Your-Account.GlueNow.com
+    
+        account = Glue::RSS.new( "your-account" )
+        
+2. Request posts from the RSS feed
+
+    * If you want all of them don't include any limiting or range. Defaults to up to 999 posts on one page
+    
+        response = account.feed
+        
+    * If you want to limit the results include a limit (1-999) and which page (used for paging)
+
+        response = account.feed(10, 3)
+        
+3. Get an RSS feed back or HTML page - These Examples are simplified to include most important nodes
+
+    * A successful RSS response would look like 
+    
+        response #=> {"rss"=>{"channel"=>{"item"=>{"pubDate"=>"Fri, 12 Sep 2008 00:00:00 +0000","title"=>"My Title","guid"=>"http://jordandobson.com#14415","dc:creator"=>"Jordan","description"=>"<p>My Body</p>","link"=>"http://jordandobson.com","source"=>"Glue"}}}} 
+    
+    * A failed HTML responsed would look like
+    
+        response #=> {"html"=>{"head"=>{"title"=>"GLUE | Web + Mobile Content Publishing"},"body"=>"<p>Webpage Body</p>"}}
+
+== REQUIREMENTS:
+
+* Mechanize & HTTParty
+* Mocha (for tests)
+
+== INSTALL:
+
+* sudo gem install jordandobson-glue -include-dependencies
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Squad, Inc.
+
+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,16 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/glue.rb'
+
+Hoe.new('glue', Glue::VERSION) do |p|
+  # p.rubyforge_name = 'gluex' # if different than lowercase project name
+  p.developer('Jordan Dobson', 'jordan.dobson@madebysquad.com')
+  p.extra_deps      = ['mechanize']
+  p.extra_deps      = ['httparty']
+  p.extra_dev_deps  = ['mocha']
+  p.remote_rdoc_dir = '' # Release to root
+end
+
+# vim: syntax=Ruby

data/lib/glue.rb

@@ -1,87 +1,64 @@
-# = Glue
-#
-# Copyright (c) 2004-2006, George Moschovitis (http://www.gmosx.com)
-#
-# Glue (http://www.nitroproject.org) is copyrighted free software 
-# created and maintained by George Moschovitis (mailto:george.moschovitis@gmail.com) 
-# and released under the standard BSD Licence. For details 
-# consult the file doc/LICENCE.
+require 'rubygems'
+require 'httparty'
+require 'nokogiri'
+require 'open-uri'
 
-require 'English'
-require 'pp'
-
-require 'facet/nullclass'
-require 'facets/more/paramix' # keep this before module/is
-require 'facets/core/module/is'
-require 'facets/core/class/cattr'
+module Glue
 
-require 'glue/attribute'
-require 'glue/attributeutils'
+  VERSION = '1.0.0'
+  DOMAIN  = 'gluenow.com'
 
-# Glue is a collection of reusable utilities and methods to 
-# especially suited to Nitro and Og coding. We try to extract
-# more generally useful parts of Glue into the Facets project.
-# For more information about Facets have a look at:
-#
-# http://rubyforge.org/projects/facets/
-#
-# The Glue module is included by default in the TopLevel 
-# for easy access to the utilities. Just use:
-#
-# $GLUE_DONT_INCLUDE = true
-#
-# before including Glue to dissable this behaviour.
+  class AuthError < StandardError;                   end
+  class FormatHelper; include HTTParty; format :xml; end
 
-module Glue
+  class API < Glue::FormatHelper
+  
+    POST   = '/api/post'
+    USER   = '/api/user'
 
-  # The version.
+    def initialize subdomain, user, pass
+      raise  AuthError, 'Username, Password or Account subdomain is blank.' \
+        if subdomain.empty? || user.empty? || pass.empty?
+      @auth   = { :username => user, :password => pass }
+      @site   = "#{subdomain}.#{DOMAIN}"
+      self.class.base_uri @site
+    end
 
-  Version = '0.31.0'
-  
-  # Library path.
+    def valid_site?
+      Nokogiri::HTML(open("http://#{@site}")).at('body#login') ? true : false
+    end
 
-  LibPath = File.dirname(__FILE__)
+    def user_info
+      self.class.post(USER, :query => {}, :basic_auth => @auth)
+    end
 
-end
+    def post title, body, *opts
+      self.class.post(
+        POST,
+        :query      =>  {
+        :title      =>  title,
+        :body       =>  body,
+        :draft      =>  opts.include?( :draft  )  ,
+        :author     =>  opts.include?( :author )  },
+        :basic_auth =>  @auth
+      )
+    end
 
-class NilClass
-  # quite usefull for error tolerant apps.
-  # a bit dangerous? Will have to rethink this.
-  
-  def empty?
-    true
   end
   
-  def blank?
-    true
-  end  
-end
+  class RSS < Glue::FormatHelper
 
-class Class
-  #--
-  # gmosx: is this really needed?
-  #++
+    NEWS = '/news/rss'
+    
+    def initialize subdomain
+      raise  AuthError, 'Account Subdomain is missing or blank' if subdomain.empty?
+      self.class.base_uri "#{subdomain}.#{DOMAIN}"
+    end
+    
+    def feed limit=999, page=1
+      self.class.get("#{NEWS}?limit=#{limit}&page=#{page}")
+    end
   
-  def to_i
-    return self.hash
   end
-end
-
-module Kernel
-  # Pretty prints an exception/error object
-  # usefull for helpfull debug messages
-  #
-  # Input:
-  # The Exception/StandardError object
-  #
-  # Output:
-  # the pretty printed string
-  
-  def pp_exception(ex)
-    return %{#{ex.message}\n  #{ex.backtrace.join("\n  ")}\n  LOGGED FROM: #{caller[0]}}
-  end
-end
-
-# Include in the top level binding for easy access.
 
-include Glue unless $GLUE_DONT_INCLUDE
+end

data/test/test_glue.rb

@@ -0,0 +1,218 @@
+require "test/unit"
+require "#{File.dirname(__FILE__)}/../lib/glue.rb"
+require "mocha"
+
+class TestGlue < Test::Unit::TestCase
+
+  def setup
+    @subdomain  = 'AccountSubDomain'
+    @username   = 'Username'
+    @password   = 'Password'
+    @client     = Glue::API.new( @subdomain, @username, @password )
+    @title      = "My Title"
+    @title2     = "Your Title"
+    @body       = "Body Text"
+    @body2      = "Hello World"
+    @url        = "http://bit.ly/sakIM"
+    @id         = "14415"
+    @id2        = "14416"
+    @lurl       = "http://jordandobson.com"
+    @guid       = "#{@lurl}##{@id}"
+    @guid2      = "#{@lurl}##{@id2}"
+    @author     = "Jordan"
+    
+    @resp_fail  = {}
+    
+    @resp_ok    = { "rsp"     => {
+                    "user"    => {
+                    "author"  => @author,
+                    "admin"   => "true"  ,
+                    "email"   => nil    },
+                    "stat"    => "ok"   }}
+                    
+    @post_ok    = { "rsp"     => {
+                    "post"    => {
+                    "title"   => @title , 
+                    "url"     => @url   , 
+                    "id"      => @id    , 
+                    "longurl" => @lurl  },
+                    "stat"    => "ok"   }}
+                    
+    @rss        = { "rss"         => {
+                    "channel"     => {
+                    "item"        => {
+                    "pubDate"     => "Fri, 12 Sep 2008 00:00:00 +0000", 
+                    "title"       => @title             , 
+                    "guid"        => @guid              , 
+                    "dc:creator"  => @author            , 
+                    "description" => "<p>#{@body}</p>"  , 
+                    "link"        => @lurl              ,
+                    "source"      => "Glue"             }}}}
+                    
+    @rss_many   = { "rss"         => {
+                    "channel"     => {
+                    "item"        => [{
+                    "pubDate"     => "Fri, 12 Sep 2008 00:00:00 +0000", 
+                    "title"       => @title             , 
+                    "guid"        => @guid              , 
+                    "dc:creator"  => @author            , 
+                    "description" => "<p>#{@body}</p>"  , 
+                    "link"        => @lurl              ,
+                    "source"      => "Glue"             },{
+                    "pubDate"     => "Fri, 12 Sep 2009 00:00:00 +0000", 
+                    "title"       => @title2            , 
+                    "guid"        => @guid2             , 
+                    "dc:creator"  => nil                , 
+                    "description" => "<p>#{@body2}</p>" , 
+                    "link"        => @lurl              ,
+                    "source"      => "Glue"             }]}}}
+                    
+    @rss_empty  = { "rss"         => {
+                    "channel"     => {
+                    "pubDate"     => "Tue, 18 Aug 2009 10:48:28 +0000"  ,
+                    "webMaster"   =>  "glue@jordan.gluenow.com (Glue)"  ,
+                    "link"        =>  "http://jordandobson.com"         }}}
+                    
+    @html_page  = { "html"        => {
+                    "head"        => {
+                    "title"       => "GLUE | Web + Mobile Content Publishing" },
+                    "body"        => "<p>Webpage Body</p>"                    }}
+  end
+
+  def test_raises_without_account_url
+    assert_raise Glue::AuthError do
+      Glue::API.new( '' , @username, @password )
+    end
+  end
+
+  def test_raises_without_user
+    assert_raise Glue::AuthError do
+      Glue::API.new( @subdomain, '', @password )
+    end
+  end
+
+  def test_raises_without_password
+    assert_raise Glue::AuthError do
+      Glue::API.new( @subdomain, @username, '' )
+    end
+  end
+
+  def test_raises_with_number_account_url
+    assert_raise NoMethodError do
+      Glue::API.new( 00 , @username, @password )
+    end
+  end
+
+  def test_raises_with_number_user
+    assert_raise NoMethodError do
+      Glue::API.new( @subdomain, 00, @password )
+    end
+  end
+
+  def test_raises_with_number_password
+    assert_raise NoMethodError do
+      Glue::API.new( @subdomain, @username, 00 )
+    end
+  end
+
+  def test_site_is_valid
+    OpenURI.stubs(:open_uri).returns('<body id="login"></body>')
+    assert    @client.valid_site?
+  end
+
+  def test_site_is_invalid
+    OpenURI.stubs(:open_uri).returns('<body></body>')
+    assert   !@client.valid_site?
+  end
+
+  def test_user_info_valid
+    Glue::API.stubs(:post).returns(@resp_ok)
+    actual       = @client.user_info
+    assert_equal   "ok",     actual["rsp"]["stat"]
+    assert                   actual["rsp"]["user"]
+    assert_equal   "Jordan", actual["rsp"]["user"]["author"]
+    assert_equal   "true",   actual["rsp"]["user"]["admin"]
+    assert_equal   nil,      actual["rsp"]["user"]["email"]
+  end
+
+  def test_user_info_invalid
+    Glue::API.stubs(:post).returns(@resp_fail)
+    actual       = @client.user_info
+    assert_equal   @resp_fail, actual
+  end
+
+  def test_bad_post_response
+    Glue::API.stubs(:post).returns(@resp_fail)
+    actual       = @client.post(@title, @body)
+    assert_equal   @resp_fail, actual
+  end
+
+  def test_good_post_response
+    Glue::API.stubs(:post).returns(@post_ok)
+    actual       = @client.post(@title, @body)
+    assert_equal   "ok",     actual["rsp"]["stat"]
+    assert                   actual["rsp"]["post"]
+    assert_equal   @title,   actual["rsp"]["post"]["title"]
+    assert_equal   @url,     actual["rsp"]["post"]["url"]
+    assert_equal   @id,      actual["rsp"]["post"]["id"]
+    assert_equal   @lurl,    actual["rsp"]["post"]["longurl"]
+  end
+  
+  # Need to test posting with the options
+  
+  def test_reading_single_post
+      Glue::RSS.stubs(:get).returns(@rss)
+      actual      = Glue::RSS.new('jordan').feed(1,1)['rss']['channel']["item"]
+      assert_equal  @title,  actual["title"]
+      assert_match  @body,   actual["description"]
+      assert_equal  @lurl,   actual["link"]
+      assert_equal  @guid,   actual["guid"]
+      assert_equal  @author, actual["dc:creator"]
+  end
+  
+  def test_reading_multiple_posts
+      Glue::RSS.stubs(:get).returns(@rss_many)
+      actual      = Glue::RSS.new('jordan').feed['rss']['channel']["item"]
+      assert_equal  2,       actual.length
+
+      # First Article
+      assert_equal  @title,  actual.first["title"]
+      assert_match  @body,   actual.first["description"]
+      assert_equal  @lurl,   actual.first["link"]
+      assert_equal  @guid,   actual.first["guid"]
+      assert_equal  @author, actual.first["dc:creator"]
+
+      # Last Article
+      assert_equal  @title2, actual.last["title"]
+      assert_match  @body2,  actual.last["description"]
+      assert_equal  nil,     actual.last["dc:creator"]
+      assert_equal  @lurl,   actual.last["link"]
+      assert_equal  @guid2,  actual.last["guid"]
+      
+      assert_not_equal  actual.first["title"],       actual.last["title"]
+      assert_not_equal  actual.first["description"], actual.last["description"]
+      assert_not_equal  actual.first["dc:creator"],  actual.last["dc:creator"]
+      assert_not_equal  actual.first["guid"],        actual.last["guid"]
+      assert_equal      actual.first["link"],        actual.last["link"]
+  end
+  
+  def test_no_public_posts_available
+      Glue::RSS.stubs(:get).returns(@rss_empty)
+      subdomain  = 'jordan'
+      actual     = Glue::RSS.new(subdomain).feed
+      assert       actual["rss"]["channel"]
+      assert_nil   actual["rss"]["channel"]["item"]
+      assert_match subdomain,   actual["rss"]["channel"]["webMaster"]
+  end
+  
+  def test_bad_url
+      Glue::RSS.stubs(:get).returns(@html_page)
+      actual    = Glue::RSS.new('666-DIE-666').feed
+      assert      actual["html"]
+      assert_nil  actual["rss"]
+      assert_raise NoMethodError do
+        actual["rss"]["channel"]
+      end      
+   end
+
+end