firefly-client 0.4.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/.rvmrc

@@ -0,0 +1 @@
+rvm 1.8.7-p249@firefly-client

data/HISTORY

@@ -0,0 +1,3 @@
+= 0.4.0 - 2010-06-06 
+
+ * 2010-06-06 - Initial release [ariejan]

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Ariejan de Vroom
+
+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/README.md

@@ -0,0 +1,61 @@
+# FireFly Client
+
+FireFly is a simple URL shortener for personal use. This is the client to be used in conjunction with a server installation. 
+
+See [http://github.com/ariejan/firefly][1] for details on the server.
+
+# Installation
+
+    sudo gem install firefly-client
+
+# Usage
+
+    require 'rubygems'
+    require 'firefly-client'
+    
+		firefly = Firefly::Client.new("http://aj.gs", "my_api_key")
+		firefly.shorten("http://google.com") => "http://aj.gs/8ds"
+
+# Bugs, Feature Requests, etc. 
+
+ * [Source][2]
+ * [Issue tracker][3]
+
+[1]: http://github.com/ariejan/firefly
+[2]: http://github.com/ariejan/firefly-client
+[3]: http://github.com/ariejan/firefly/issues
+
+Feel free to fork Firefly Client and create patches for it. Here are some basic instructions:
+
+ * [Fork][4] Firefly Client
+ * Create a topic branch - `git checkout -b my_branch`
+ * Push to your branch - `git push origin my_branch`
+ * Create an [Issue][5] with a link to your branch
+ * That's it!
+ 
+[4]: http://help.github.com/forking/
+[5]: http://github.com/ariejan/firefly-client/issues
+
+# License
+
+    Copyright (c) 2010 Ariejan de Vroom
+    
+    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,46 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "firefly-client"
+    gem.summary = %Q{A client for the Firefly URL shortener server}
+    gem.description = %Q{This is a client Gem for the Firefly URL shortener. It allows you Ruby application to call Firefly directly to shorten URLs.}
+    gem.email = "ariejan@ariejan.net"
+    gem.homepage = "http://github.com/ariejan/firefly-client"
+    gem.authors = ["Ariejan de Vroom"]
+		gem.add_dependency "httparty", ">= 0.5.2"
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+		gem.add_development_dependency "fakeweb", ">= 1.2.8"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "firefly-client #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.4.0

data/lib/firefly-client.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'httparty'
+
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'firefly/client'

data/lib/firefly/client.rb

@@ -0,0 +1,59 @@
+module Firefly
+  
+  # Firefly::Client allows you to shorten URLs quickily through a Firefly server. 
+  #
+  # Usage is easy:
+  #
+  #     firefly = Firefly::Client.new(url, api_key)
+  #     firefly.shorten("http://google.com")
+  #
+  class Client
+		
+		# Creates a new instance to shorten Firefly URLs
+		# 
+		# +url+ is the URL to your Firefly server. E.g. "http://aj.gs". 
+		# Note: do not include a trailing slash
+		# +api_key+ is your Firefly API Key.
+		def initialize(url, api_key)
+			@firefly_url = url
+			@api_key     = api_key
+		end	
+		
+		# Shortens the given URL or array of URLs. 
+		#
+		#    shorten("http://google.com") => "http://aj.gs/7dZ"
+    #
+    #    shorten(["http://google.com", "http://yahoo.com"])
+    #				=> { "http://google.com/" => "http://aj.gs/7dZ", 
+    #            "http://yahoo.com/"  => "http://aj.gs/8Yt" } 
+    def shorten(input)
+			if input.is_a?(String)
+			  return create_url(input)	
+			elsif input.is_a?(Array)
+				result = {}
+				input.each do |inp|
+					result[inp] = create_url(inp)
+				end
+        return result 
+			else
+				raise ArgumentError.new('Shorten requires either a url or an array of urls')
+			end
+		end
+		
+		protected
+
+		# Shortend +long_url+ and returns the short_url on success
+		def	create_url(long_url)
+		  begin
+			  options = { :query => { :url => long_url, :api_key => @api_key } }
+        result = HTTParty.post(@firefly_url + '/api/add', options)
+
+				if result =~ /Permission denied/i
+          raise "Permission denied. Is your API Key set correctly?" if result.status = 401
+				else
+				  return result
+				end
+			end
+		end
+  end
+end

data/lib/firefly_client.rb

@@ -0,0 +1 @@
+require 'firefly-client'

data/spec/firefly-client_spec.rb

@@ -0,0 +1,35 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "FireflyClient" do
+	
+  describe "successful calls" do
+		before(:each) do
+		  FakeWeb.register_uri(:post, /^http:\/\/tst\.hst\/api\/add.*google\.com$/, :body => "http://tst.hst/7dX")
+		  FakeWeb.register_uri(:post, /^http:\/\/tst\.hst\/api\/add.*yahoo\.com$/, :body => "http://tst.hst/rX9")
+			@client = Firefly::Client.new('http://tst.hst', 'test')
+		end
+
+	  it "should call http://test.host/api/add correctly" do
+      @client.shorten("http://google.com").should eql("http://tst.hst/7dX")
+	  end
+
+		it "should shorten multiple urls correctly" do
+      result = @client.shorten(["http://google.com", "http://yahoo.com"])
+			result["http://google.com"].should eql("http://tst.hst/7dX")
+			result["http://yahoo.com"].should eql("http://tst.hst/rX9")
+		end
+	end
+
+  describe "API permission errors" do
+		before(:each) do
+		  FakeWeb.register_uri(:post, /^http:\/\/tst\.hst\/api\/add.*google\.com$/, :status => 401, :body => "Permission denied")
+			@client = Firefly::Client.new('http://tst.hst', 'fail')
+		end
+
+	  it "should raise an error" do
+			lambda {
+        @client.shorten("http://google.com")
+			}.should raise_error
+	  end
+	end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'firefly-client'
+require 'spec'
+require 'spec/autorun'
+require 'fakeweb'
+
+FakeWeb.allow_net_connect = false
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification 
+name: firefly-client
+version: !ruby/object:Gem::Version 
+  hash: 15
+  prerelease: false
+  segments: 
+  - 0
+  - 4
+  - 0
+  version: 0.4.0
+platform: ruby
+authors: 
+- Ariejan de Vroom
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-06 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 0
+        - 5
+        - 2
+        version: 0.5.2
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: fakeweb
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 2
+        - 8
+        version: 1.2.8
+  type: :development
+  version_requirements: *id003
+description: This is a client Gem for the Firefly URL shortener. It allows you Ruby application to call Firefly directly to shorten URLs.
+email: ariejan@ariejan.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .document
+- .gitignore
+- .rvmrc
+- HISTORY
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- lib/firefly-client.rb
+- lib/firefly/client.rb
+- lib/firefly_client.rb
+- spec/firefly-client_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/ariejan/firefly-client
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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.3.7
+signing_key: 
+specification_version: 3
+summary: A client for the Firefly URL shortener server
+test_files: 
+- spec/firefly-client_spec.rb
+- spec/spec_helper.rb