trim-api 0.1 → 0.3

data/History.txt

@@ -1,7 +1,12 @@
+=== 0.3 / 2009-10-24
+
+* Added trim_reference method
+* Added trim_claim method
+
 === 0.1 / 2009-10-23
 
 * Added trim_destination method that returns the destination for a trimmed url
-* Added authentication (currently only required for trim_destination)
+* Added authentication (currently only required for trim_destination but must be used in initialisation)
 
 === 0.0.1 / 2009-10-18
 

data/README.txt

@@ -8,7 +8,8 @@ A simple Ruby library for accessing the tr.im API
 
 == FEATURES/PROBLEMS:
 
-Currently only supports the trimming of a URL with limited error checking.
+Supports trimming and expanding of URLS.
+More features coming soon.
 
 == REQUIREMENTS:
 
@@ -26,10 +27,24 @@ gem install trim-api
 require 'rubygems'
 require 'trim_api'
 
-api = TrimApi::Trim.new
+* Authentication on the initialisation is only required if you intend to use an API call that requires authentication. For example, to trim a url, no authentication is required.
+
+api = TrimApi::Trim.new(:username => "username", :password => "password")
 api.trim("http://www.google.com/")
 
-Returns the trimmed url as a string.
+Returns the trimmed url as a string in the format http://tr.im/ABCD
+
+api.trim_destination("CMo5")
+
+Returns the original destination as a string.
+
+api.trim_reference("CMo5")
+
+Returns the reference for the trimmed url if the authenticated user owns the trimmed url.
+
+api.trim_claim("dkajdsakjdamnsdsma")
+
+Claims a url identified by the unique reference obtained by trim_reference and attaches it to the authenticated user's account.
 
 == LICENSE:
 

data/lib/trim-api/trim-api.rb

@@ -28,14 +28,14 @@ module TrimApi
       unless data["status"]["result"] == "OK"
         raise TrimError.new(data["status"]["code"],data["status"]["message"])
       else
-        data["url"]
+        "http://tr.im/#{data['url']}"
       end
     end
     
     def trim_destination(trimmed_url, options = {})
       raise ArgumentError.new(":trimmed url is required") if trimmed_url.nil?
       raise ArgumentError.new(":username and password are required") if (username.nil? || password.nil?)
-      response = @client.get_content(create_url("trim_destination", {:trimpath => trimmed_url, :username => username, :password => password}))
+      response = @client.get_content(create_url("trim_destination",options.merge!({:trimpath => trimmed_url, :username => username, :password => password})))
       data = JSON.parse(response)
       unless data["status"]["result"] == "OK"
         raise TrimError.new(data["status"]["code"],data["status"]["message"])
@@ -44,6 +44,30 @@ module TrimApi
       end
     end
     
+    def trim_reference(trimmed_url, options = {})
+      raise ArgumentError.new(":trimmed url is required") if trimmed_url.nil?
+      raise ArgumentError.new(":username and password are required") if (username.nil? || password.nil?)
+      response = @client.get_content(create_url("trim_reference", options.merge!({:trimpath => trimmed_url, :username => username, :password => password})))
+      data = JSON.parse(response)
+      unless data["status"]["result"] == "OK"
+        raise TrimError.new(data["status"]["code"],data["status"]["message"])
+      else
+        data["reference"]
+      end
+    end
+    
+    def trim_claim(reference, options = {})
+      raise ArgumentError.new(":url reference is required. Use trim_reference to obtain this.") if reference.nil?
+      raise ArgumentError.new(":username and password are required") if (username.nil? || password.nil?)
+      response = @client.get_content(create_url("trim_claim", options.merge!({:reference => reference, :username => username, :password => password})))
+      data = JSON.parse(response)
+      unless data["status"]["result"] == "OK"
+        raise TrimError.new(data["status"]["code"],data["status"]["message"])
+      else
+        "URL successfully claimed and added to your account"
+      end
+    end
+    
     private
     
     def create_url(method, options = {})

data/lib/trim_api.rb

@@ -5,5 +5,5 @@ require 'CGI'
 require 'trim-api/trim-api.rb'
 
 module TrimApi
-  VERSION = '0.1'
+  VERSION = '0.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: trim-api
 version: !ruby/object:Gem::Version 
-  version: "0.1"
+  version: "0.3"
 platform: ruby
 authors: 
 - Robin Fisher
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-23 00:00:00 +01:00
+date: 2009-10-24 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency