llremote 0.6.0

data/CHANGELOG

@@ -0,0 +1,3 @@
+*0.6.0* (9 June 2009)
+
+* First release as a gem

data/LICENSE

@@ -0,0 +1,165 @@
+		   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README

@@ -0,0 +1,76 @@
+= LogiLogi Remote Gem documentation
+  "Your remote control for LogiLogi"
+
+Allows you to update and create Logis on http://www.LogiLogi.org from 
+any application.
+
+LLRemote is a library by the LogiLogi Foundation
+(http://foundation.logilogi.org).
+
+== Usage
+
+First require it.
+
+  $ irb
+
+  > require 'rubygems'
+  > require 'llremote'
+
+First set it up for connecting
+
+  > LLRemote.setup(:access_token => <your API access token>)
+
+Then initialize the remote logi
+
+  > logi = LLRemote::Logi.new(
+  >   :link => "Interesting/New",
+  >   :title => "My shiny new Logi",
+  >   :body => "New things come about...")
+
+And save it.
+
+  > logi.save
+
+It's that easy.
+
+== Installation
+
+You can install LogiLogi Remote with the following command:
+
+  % [sudo] gem install llremote
+
+The latest version of LogiLogi Remote can also be downloaded at:
+
+* http://rubyforge.org/frs/?group_id=8494
+
+And then from its distribution directory installed with:
+
+  % [sudo] ruby install.rb
+
+== Support
+
+The LogiLogi Remote homepage is http://textweaver.rubyforge.org.
+
+For the latest news on LogiLogi Remote:
+
+* http://foundation.logilogi.org/tags/LLRemote
+
+Feel free to submit commits or feature requests. If you send a patch,
+remember to update the corresponding unit tests.
+
+== This Documentation
+
+This documentation can be browsed online at:
+
+* http://llremote.rubyforge.org
+
+== Copyrights
+
+LogiLogi Remote and these docs are Copyright (c) 2006-2009 The LogiLogi
+Foundation. LLRemote is licensed under the {GNU Lesser General Public 
+License}[http://www.gnu.org/licenses/lgpl-3.0-standalone.html].
+These docs are available under the {Creative Commons Attribution-Share
+Alike License}[http://creativecommons.org/licenses/by-sa/3.0/].
+
+You can use LLRemote in an application that is not Free Software
+but LLRemote itself remains Free Software.

data/Rakefile

@@ -0,0 +1,91 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+require 'rake/contrib/sshpublisher'
+require File.join(File.dirname(__FILE__), 'lib', 'l_l_remote', 'version')
+
+PKG_BUILD     = ENV['PKG_BUILD'] ? '.' + ENV['PKG_BUILD'] : ''
+PKG_NAME      = 'llremote'
+PKG_VERSION   = LLRemote::VERSION::STRING + PKG_BUILD
+PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
+
+RELEASE_NAME  = "REL #{PKG_VERSION}"
+
+RUBY_FORGE_PROJECT = "llremote"
+RUBY_FORGE_USER    = "wybow"
+
+desc "Default Task"
+task :default => [ :test ]
+
+# Run the unit tests
+Rake::TestTask.new { |t|
+  t.libs << "test"
+  t.pattern = 'test/*_test.rb'
+  t.verbose = true
+  t.warning = false
+}
+
+# Generate the RDoc documentation
+Rake::RDocTask.new { |rdoc|
+  rdoc.rdoc_dir = 'doc'
+  rdoc.title    = "LLRemote -- Your remote control for LogiLogi"
+  rdoc.options << '--line-numbers' << '--inline-source' << '-A cattr_accessor=object'
+  rdoc.options << '--charset' << 'utf-8'
+  rdoc.rdoc_files.include('README', 'CHANGELOG')
+  rdoc.rdoc_files.include('lib/l_l_remote.rb')
+  rdoc.rdoc_files.include('lib/l_l_remote/*.rb')
+}
+
+# Create compressed packages
+spec = Gem::Specification.new do |s|
+  s.platform = Gem::Platform::RUBY
+  s.name = PKG_NAME
+  s.summary = "Your remote control for LogiLogi."
+  s.description = %q{Allows you to post and update logis remotely.}
+  s.version = PKG_VERSION
+
+  s.author = "Wybo Wiersma"
+  s.email = "wybo@logilogi.org"
+  s.rubyforge_project = "llremote"
+  s.homepage = "http://llremote.rubyforge.org"
+
+  s.has_rdoc = true
+  s.requirements << 'none'
+  s.require_path = 'lib'
+
+  s.files = [ "Rakefile", "install.rb", "README", "CHANGELOG", "LICENSE" ]
+  s.files = s.files + Dir.glob( "lib/**/*" ).delete_if { |item| item.include?( "\.svn" ) }
+  s.files = s.files + Dir.glob( "test/**/*" ).delete_if { |item| item.include?( "\.svn" ) }
+end
+  
+Rake::GemPackageTask.new(spec) do |p|
+  p.gem_spec = spec
+  p.need_tar = true
+  p.need_zip = true
+end
+
+desc "Publish the docs, gem, and release files"
+task :deploy => [:release, :pdoc] do       
+  puts 'Published gem'
+end
+
+desc "Publish the API documentation"
+task :pdoc => [:rdoc] do
+  sh "rsync -azv --no-perms --no-times doc/*" +
+      " rubyforge.org:/var/www/gforge-projects/llremote"
+end
+
+desc "Publish the release files to RubyForge."
+task :release => [ :package ] do
+  require 'rubyforge'
+  require 'rake/contrib/rubyforgepublisher'
+
+  packages = %w( gem tgz zip ).collect{ |ext| "pkg/#{PKG_NAME}-#{PKG_VERSION}.#{ext}" }
+
+  rubyforge = RubyForge.new.configure
+  rubyforge.login
+  rubyforge.add_release(PKG_NAME, PKG_NAME, "REL #{PKG_VERSION}", *packages)
+end

data/install.rb

@@ -0,0 +1,30 @@
+require 'rbconfig'
+require 'find'
+require 'ftools'
+
+include Config
+
+# this was adapted from rdoc's install.rb by way of Log4r
+
+$sitedir = CONFIG["sitelibdir"]
+unless $sitedir
+  version = CONFIG["MAJOR"] + "." + CONFIG["MINOR"]
+  $libdir = File.join(CONFIG["libdir"], "ruby", version)
+  $sitedir = $:.find {|x| x =~ /site_ruby/ }
+  if !$sitedir
+    $sitedir = File.join($libdir, "site_ruby")
+  elsif $sitedir !~ Regexp.quote(version)
+    $sitedir = File.join($sitedir, version)
+  end
+end
+
+# the actual gruntwork
+Dir.chdir("lib")
+
+Find.find("l_l_remote", "l_l_remote.rb") { |f|
+  if f[-3..-1] == ".rb"
+    File::install(f, File.join($sitedir, *f.split(/\//)), 0644, true)
+  else
+    File::makedirs(File.join($sitedir, *f.split(/\//)))
+  end
+}

data/lib/l_l_remote/logi.rb

@@ -0,0 +1,125 @@
+#--#
+# Copyright: (c) 2009 The LogiLogi Foundation <foundation@logilogi.org>
+#
+# License:
+#   This file is part of the LLRemote Library. LLRemote is Free 
+#   Software. You can run/distribute/modify LLRemote under the terms 
+#   of the GNU Lesser General Public License version 3. This license
+#   states that you can use LLRemote in applications that are not Free 
+#   Software but LLRemote itself remains Free Software. (LICENSE contains 
+#   the full text of the legally binding license).
+#++#
+#
+# LLRemote::Logi is a logi that can be read and saved remotely
+
+class LLRemote::Logi
+  attr_accessor :link, :title, :body
+
+  # Initializes a logi.
+  #
+  # Options:
+  # * <tt>link</tt> = link of the logi (can have different tags 
+  #   for existing logis to update it's tags)
+  # * <tt>title</tt> = the title (optional for existing logi)
+  # * <tt>body</tt> = the body (optional for existing logi)
+  #
+  def initialize(options)
+    self.link = options[:link]
+    self.title = options[:title]
+    self.body = options[:body]
+  end
+
+  # Loads the logi with it's remote data
+  #
+  def reload
+    entry = LLRemote.load_entry(self.link)
+    self.set_from_entry(entry)
+  end
+
+  # Saves the logi. It creates it if it doesn't exist, and updates
+  # it if it does.
+  #
+  def save
+    if self.link =~ /=/
+      return self.update
+    else
+      return self.create
+    end
+  end
+
+  protected
+
+  def create
+    if self.link.nil? or self.link.empty? or
+        self.title.nil? or self.title.empty? or
+        self.body.nil? or self.body.empty?
+      raise 'Logi needs link, body and title to be created'
+    end
+     collection = Atom::Pub::Collection.new(
+        :href => LLRemote.server_url + "/do/logis/" + self.link + "/do.xml?user_credentials=" + LLRemote.access_token)
+    entry = Atom::Entry.new do |e|
+      e.title = self.title
+      e.content = self.parse_body(self.body)
+      e.categories = self.parse_tags(self.link)
+    end
+    begin
+      entry = collection.publish(entry)
+    rescue
+      raise 'Error: Could not create logi: ' + self.link
+    end
+
+    self.set_from_entry(entry)
+    return self
+  end
+
+  def update
+    if self.link.nil? or self.link.empty?
+      raise 'Logi needs link to be updated'
+    end
+
+    entry = LLRemote.load_entry(self.link)
+    entry.title = self.title if self.title
+    entry.content = self.parse_body(self.body) if self.body
+    entry.categories = self.parse_tags(self.link)
+
+    begin
+      entry.edit_link.href = entry.edit_link.href + "?user_credentials=" + LLRemote.access_token
+      entry.save!
+    rescue
+      raise 'Error: Could not update logi: ' + self.link
+    end
+
+    self.set_from_entry(entry)
+    return self
+  end
+
+  def set_from_entry(entry)
+    self.title = entry.title,
+    self.body = entry.content.to_s,
+    self.link = unparse_link(entry.links.alternate.to_s)
+  end
+
+  def parse_tags(link)
+    tags_string = link.split('=')[0]
+    tag_strings = tags_string.split('/')
+    categories = []
+    tag_strings.each do |tag_string|
+      categories << Atom::Category.new(:term => tag_string)
+    end
+    return categories
+  end
+
+  def unparse_link(raw_link)
+    link = raw_link.gsub(LLRemote.server_url + "/","")
+    link.strip!
+    return link
+  end
+
+  def parse_body(raw_body)
+    raw_body = raw_body.dup
+    raw_body.gsub!(/^(\n|\s)*/,"")
+    raw_body.gsub!(/(\n|\s)*$/,"")
+    return Atom::Content::Html.new(
+        "<p>" + raw_body.split("\n").join("</p> <p>") + "</p>")
+  end
+end

data/lib/l_l_remote/version.rb

@@ -0,0 +1,9 @@
+class LLRemote
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 6
+    TINY  = 0
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/lib/l_l_remote.rb

@@ -0,0 +1,71 @@
+#--#
+# Copyright: (c) 2009 The LogiLogi Foundation <foundation@logilogi.org>
+#
+# License:
+#   This file is part of the LLRemote Library. LLRemote is Free 
+#   Software. You can run/distribute/modify LLRemote under the terms 
+#   of the GNU Lesser General Public License version 3. This license
+#   states that you can use LLRemote in applications that are not Free 
+#   Software but LLRemote itself remains Free Software. (LICENSE contains 
+#   the full text of the legally binding license).
+#++#
+#
+# LLRemote allows you to save logis remotely.
+
+require 'rubygems'
+gem 'ratom'
+require 'atom'
+require 'atom/pub'
+
+$:.unshift(File.dirname(__FILE__)) unless
+    $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+class LLRemote
+  ### Class-attributes
+  
+  [:access_token,:server_url].each do |cattribute|
+  eval <<FUN
+    def self.#{cattribute}
+      @@#{cattribute}
+    end
+
+    def self.#{cattribute}=(attr)
+      @@#{cattribute} = attr
+    end
+FUN
+  end
+
+  ### Class-methods
+
+  # Sets the api-key and other options.
+  #
+  # Options:
+  # * <tt>access_token</tt> = the API key, required
+  # * <tt>server_url</tt> = the logilogi server, defaults to
+  #   http://en.logilogi.org
+  #
+  def self.setup(options = {})
+    raise 'Needs :access_token' if options[:access_token].nil?
+
+    LLRemote.access_token = options[:access_token]
+    if options[:server_url]
+      LLRemote.server_url = options[:server_url].gsub(/\/$/,"")
+    else
+      LLRemote.server_url = "http://en.logilogi.org"
+    end
+  end
+
+  # Loads a ratom Atom::Entry for the given link.
+  #
+  # For internal use.
+  #
+  def self.load_entry(link)
+    begin
+      return Atom::Entry.load_entry(URI.parse(LLRemote.server_url + "/" + link + "/do.xml"))
+    rescue
+      raise 'Error: Perhaps wrong credentials ?'
+    end
+  end
+end
+
+require 'l_l_remote/logi'

data/lib/llremote.rb

@@ -0,0 +1 @@
+require 'l_l_remote'

data/test/l_l_remote_test.rb

@@ -0,0 +1,23 @@
+#--#
+# Copyright: (c) 2009 The LogiLogi Foundation <foundation@logilogi.org>
+#
+# License:
+#   This file is part of the LLRemote Library. LLRemote is Free 
+#   Software. You can run/distribute/modify LLRemote under the terms 
+#   of the GNU Lesser General Public License version 3. This license
+#   states that you can use LLRemote in applications that are not Free 
+#   Software but LLRemote itself remains Free Software. (LICENSE contains 
+#   the full text of the legally binding license).
+#++#
+
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class LLRemoteTest < Test::Unit::TestCase
+  ### Initialization
+
+  def test_initialize
+    LLRemote.setup(:access_token => "Moo", :server_url => "http://bod.com")
+    assert_equal "Moo", LLRemote.access_token
+    assert_equal "http://bod.com", LLRemote.server_url
+  end
+end

data/test/logi_test.rb

@@ -0,0 +1,24 @@
+#--#
+# Copyright: (c) 2009 The LogiLogi Foundation <foundation@logilogi.org>
+#
+# License:
+#   This file is part of the LLRemote Library. LLRemote is Free 
+#   Software. You can run/distribute/modify LLRemote under the terms 
+#   of the GNU Lesser General Public License version 3. This license
+#   states that you can use LLRemote in applications that are not Free 
+#   Software but LLRemote itself remains Free Software. (LICENSE contains 
+#   the full text of the legally binding license).
+#++#
+
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class LogiTest < Test::Unit::TestCase
+  ### Initialization
+
+  def test_initialize
+    l = LLRemote::Logi.new(:link => "a", :title => "b", :body => "c")
+    assert_equal "a", l.link
+    assert_equal "b", l.title
+    assert_equal "c", l.body
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/l_l_remote'

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification 
+name: llremote
+version: !ruby/object:Gem::Version 
+  version: 0.6.0
+platform: ruby
+authors: 
+- Wybo Wiersma
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-09 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: Allows you to post and update logis remotely.
+email: wybo@logilogi.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Rakefile
+- install.rb
+- README
+- CHANGELOG
+- LICENSE
+- lib/l_l_remote/version.rb
+- lib/l_l_remote/logi.rb
+- lib/l_l_remote.rb
+- lib/llremote.rb
+- test/logi_test.rb
+- test/l_l_remote_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://llremote.rubyforge.org
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+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: 
+- none
+rubyforge_project: llremote
+rubygems_version: 1.3.4
+signing_key: 
+specification_version: 3
+summary: Your remote control for LogiLogi.
+test_files: []
+