trunkly 0.1.0

data/CHANGELOG

@@ -0,0 +1,2 @@
+v0.1.0 initial version
+

data/LICENSE

@@ -0,0 +1,202 @@
+
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README

@@ -0,0 +1,107 @@
+This Trunkly ruby client library has been developed by Filippo Diotalevi (filippo@diotalevi.com)
+and it's distributed under the terms of the Apache License v.2.0
+------------------------------------------------------------------------------------------------------
+
+This project provides a Ruby client to connect to the Trunkly API.
+
+You don't need to be a Trunkly registered user to use the API, but without your API KEY you won't be able to post new links.
+
+To register to Trunk.ly go to http://trunk.ly/ and click on Sign Up.
+Once you are signed up go on your profile page and copy the API KEY somewhere; you will use it later.
+
+
+HOW TO USE THE RUBY CLIENT
+
+The Ruby client is contained in the lib/trunkly.rb file. Remember to load this file in your ruby script before starting!
+
+1) Retrieve the latest links shared by a user
+
+t = Trunkly::Trunkly.new
+links = t.links(:user => 'fdiotalevi')    #this retrieves my 100 latest links
+
+Alternatively, you can use the dynamic method  links_by_<user-name-here>, f.i.
+
+links = t.links_by_fdiotalevi    #this retrieves my 100 latest links
+
+The method 'links' returns an array of Trunkly::Link. The meaningful instance variables of Link are
+- url 
+- title
+- tags #comma separated list of tags
+- note #description of the link
+- dt_string #date when the link was shared
+
+
+2) Retrieve your latest links
+
+You can retrieve your links in two ways:
+a) using the method explained in section 1 and your username
+
+b) using your API Key like in the example
+
+t = Trunkly::Trunkly.new('my_api_key_goes_here')
+links = t.links    #this retrieves my 100 latest links
+
+
+3) Advanced search
+
+Some examples of advanced search
+
+t = Trunkly::Trunkly.new
+links = t.links(:user => 'fdiotalevi', :tags => 'ruby')  #retrieves links shared with tag ruby   
+links = t.links(:user => 'fdiotalevi', :tags => 'ruby,rails')  #retrieves links shared with tag ruby and rails
+links = t.links(:since_time => '2011-01-01 00:00:00') #retrieves links shared after 01/01/2011. Date format is '%Y-%m-%d %H:%M:%S'
+
+You can mix and match all the search parameters in your query
+
+If you use the dynamic method, you can of course omit the user, f.i.
+
+links = t.links_by_fdiotalevi(:tags => 'ruby')  #retrieves links shared with tag ruby   
+
+
+4) Pagination
+
+By default Trunkly returns the 100 latest links. You can specify exactly how many results you want and paginate them:
+
+t = Trunkly::Trunkly.new
+t.links(:count => 10)    #returns the 10 latest links
+t.links(:count => 10, :page => 1)  #returns the 2nd page of results (so results from 11..20)
+
+An even shorter method is, after the first invocation, use the 'next_page' and 'prev_page' method
+
+t = Trunkly::Trunkly.new
+t.links(:count => 10)    #returns the 10 latest links
+t.next_page   		#returns results from 11..20
+t.prev_page			#returns restult 1..10
+
+
+5) Save a link
+
+Saving a link is very simple
+
+t = Trunkly::Trunkly.new('my_api_key_goes_here') #you need an API key to save a link
+t.save do |it|
+  it.url = 'http://github.com'
+  it.title = 'GitHub'
+  it.tags = ['git','vcs']
+  it.note = 'GitHub website'
+end
+
+Note that 'tags' and 'note' are optional parameters.
+
+Alternative way (longer and dumber):
+
+t = Trunkly::Trunkly.new('my_api_key_goes_here') #you need an API key to save a link
+it = Trunkly::Link.new
+it.url = 'http://github.com'
+it.title = 'GitHub'
+it.tags = ['git','vcs']
+it.note = 'GitHub website'
+t.save it
+
+Alternative alternative way:
+
+t = Trunkly::Trunkly.new('my_api_key_goes_here') #you need an API key to save a link
+it = Trunkly::Link.new(
+	{:url => 'http://github.com', :title=> 'GitHub', :tags => ['git','vcs'], :note => 'GitHub website'}
+	)
+t.save it	

data/lib/trunkly.rb

@@ -0,0 +1,143 @@
+require 'rubygems'
+require 'json'
+require 'net/http'
+require 'uri'
+
+module Trunkly
+  
+  class Trunkly
+    
+    attr_accessor :api_key
+    
+    LINKS = "http://trunk.ly/api/v1/links/"
+    LINK = "http://trunk.ly/api/v1/link/"    
+    
+    def initialize(key = nil)
+      @api_key = key 
+      @last_used_params = {}
+      @next_page, @prev_page = 0, 0
+    end
+    
+    def links(params = {})
+      @last_used_params = params 
+      response = Net::HTTP.get_response(get_links(params))
+      case response
+      when Net::HTTPUnauthorized then
+        raise AuthorizationError, "Unauthorized: no or wrong api_key"      
+      when Net::HTTPSuccess
+        links = []
+        result = JSON.parse(response.body)
+        @prev_page, @next_page = result['prev_page'] || 0, result['next_page'] || 0
+        result['links'].each do |it| 
+          links << Link.new(it) 
+        end
+        links
+      else 
+        raise ApiError, "Exception trying to get links: "+response.body.to_s
+      end
+    end
+    
+    def save(link = Link.new)
+      raise ArgumentError, "save method parameter must be a Trunkly::List" unless link.class == Link
+      yield link if block_given?
+      post_params = link.to_hash
+      post_params[:api_key] = @api_key
+      response = Net::HTTP.post_form(URI.parse(LINK), post_params)    
+      case response
+      when Net::HTTPSuccess
+        response
+      else
+        raise ApiError, "Exception trying to save a link: "+response.body.to_s
+      end
+    end
+    
+    def next_page
+      @last_used_params[:page] = @next_page
+      links @last_used_params
+    end
+    
+    def prev_page
+      @last_used_params[:page] = @prev_page
+      links @last_used_params      
+    end
+    alias :previous_page :prev_page
+    
+    def method_missing(method_id, *args)
+      if method_id.to_s =~/^links_by_(.*)/
+        args << {} if args.size == 0
+        args[0][:user] = $1
+        links args[0]
+      else
+        super
+      end
+    end
+    
+        
+    private
+    
+    def get_links(params = {})
+      userpart = params[:user] ? "#{params[:user]}/" : "";
+      URI.parse(URI.escape(LINKS + userpart + query_string(params)))
+    end
+          
+    def query_string(params = {})
+      query_string = ""
+      params.each_pair do |k, v|
+        query_string += "&#{k.to_s}=#{v}" unless k == :user
+      end
+      query_string += "&api_key=#{@api_key}" if @api_key #adds api key if available
+      query_string[0] = '?' if query_string[0] == '&'
+      query_string
+    end
+          
+  end
+  
+
+
+  class Link
+    
+    attr_reader :lid, :dt_string, :tags
+    attr_accessor :url, :title, :note
+    
+    def initialize(params = {})
+      %w[url lid title dt_string note url tags].each { |it| set_param(params, it) }
+      @tags = [@tags] if @tags.class == String
+      @tags = [] unless @tags
+    end
+    
+    def tags=(some_tags)
+      if some_tags.class == String
+        @tags = some_tags.split(',') 
+      else
+        @tags = some_tags
+      end
+    end
+    
+    def to_s
+      "title: #{@title}\nurl: #{@url}\ntags: #{@tags.join(',')}\n\n"
+    end
+    
+    def to_hash
+      params = {}
+      %w[url lid title dt_string note url].each { |it| hash_param(params, it) }
+      params['tags'] = @tags.join(',') if @tags
+      params
+    end
+    
+    def hash_param(params, name)
+      params[name] = instance_variable_get("@#{name}") if instance_variable_get("@#{name}")
+    end
+    
+    def set_param(params, name)
+      instance_variable_set("@#{name}", params[name])
+    end
+    
+  end    
+  
+  
+  class AuthorizationError < StandardError
+  end
+  
+  class ApiError < StandardError
+  end
+end  

data/test/helper.rb

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

data/test/test_trunkly.rb

@@ -0,0 +1,92 @@
+require File.join(File.dirname(__FILE__), "helper.rb")
+
+class TestTrunkly < Test::Unit::TestCase
+
+  def test_can_instantiate
+    assert_not_nil Trunkly::Trunkly.new
+  end
+  
+  def test_api_key_nil_if_not_initialized
+    assert_nil Trunkly::Trunkly.new.api_key
+  end
+  
+  def test_api_key_set_if_initialized
+    assert_equal '12345', Trunkly::Trunkly.new('12345').api_key
+  end
+  
+  # def test_get_public_links
+  #   timslinks = Trunkly::Trunkly.new.links(:user => 'timbull')
+  #   assert timslinks.size > 50
+  # end
+  
+  def test_query_string
+    t = Trunkly::Trunkly.new
+    assert_equal "", t.send("query_string", {})
+    
+    params = {}
+    params[:user] = 'a'
+    assert_equal "", t.send("query_string", params)
+    
+    params = {}
+    params[:one] = 1
+    assert_equal "?one=1", t.send("query_string", params)
+    
+    params = {}
+    params[:one] = 1
+    params[:two] = 2
+    assert_equal "?one=1&two=2", t.send("query_string", params)
+    
+    t.api_key = '12345'
+    params = {}
+    params[:one] = 1
+    assert_equal "?one=1&api_key=12345", t.send("query_string", params)
+  end
+  
+  def test_link_empty_initializer
+    l = Trunkly::Link.new
+    assert_nil l.url
+    assert_nil l.lid
+    assert_equal [], l.tags  
+    assert_nil l.note      
+    assert_nil l.dt_string
+    assert_nil l.title            
+  end
+
+  def test_link_initializer
+    l = Trunkly::Link.new
+    l.title = 'title'
+    l.url = 'url'
+    l.note = 'note'    
+    assert_equal 'url', l.url
+    assert_equal 'note', l.note      
+    assert_equal 'title', l.title            
+  end
+  
+  def test_link_tags_handling
+    l = Trunkly::Link.new
+
+    l.tags = "one"    
+    assert_equal ['one'], l.tags
+    
+    l.tags = "one,two"    
+    assert_equal ['one','two'], l.tags
+        
+    l.tags = [1,2,3]    
+    assert_equal [1,2,3], l.tags
+  end
+    
+  
+  def test_link_to_hash
+    l = Trunkly::Link.new
+    l.title = 'title'
+    l.url = 'url'
+    l.note = 'note'
+    h = l.to_hash
+    assert_equal 'title', h['title']
+    assert_equal 'url', h['url']
+    assert_equal 'note', h['note']        
+    assert_nil h['lid']    
+  end
+  
+  
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification 
+name: trunkly
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Filippo Diotalevi
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-12 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :runtime
+  version_requirements: *id001
+description: A Ruby Client for Trunk.ly API
+email: 
+- filippo.diotalevi@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- CHANGELOG
+- LICENSE
+- README
+- lib/trunkly.rb
+- test/helper.rb
+- test/test_trunkly.rb
+has_rdoc: true
+homepage: https://github.com/fdiotalevi/trunkly-ruby
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+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: 
+rubygems_version: 1.4.2
+signing_key: 
+specification_version: 3
+summary: Ruby Client for Trunk.ly API
+test_files: 
+- test/helper.rb
+- test/test_trunkly.rb