shorty_client 0.5.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/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Brad Gessler
+
+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.rdoc

@@ -0,0 +1,27 @@
+= Shorty client
+
+Shorty makes is easier to implement your very own URL shortener. The client is designed to be used with a Shorty server to make it easier to shorten URLs from your ruby application.
+
+    Shorty::Client.new "http://my.shorty.server/" do |s|
+      if short_url = s.shorten "http://www.google.com/"
+        puts "It worked! See it at #{short_url}"
+      else
+        puts shorty.errors.join(', ')
+      end
+    end
+
+Pretty rad!
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Brad Gessler. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "shorty_client"
+    gem.summary = %Q{Work with your shorty server from Ruby}
+    gem.description = %Q{The shorty client is a convienent wrapper for interacting with your shorty server from your Ruby projects.}
+    gem.email = "brad@bradgessler.com"
+    gem.homepage = "http://github.com/bradgessler/shorty_client"
+    gem.authors = ["Brad Gessler"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  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 = "shorty_client #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.5.0

data/lib/shorty/client.rb

@@ -0,0 +1,79 @@
+require 'net/http'
+require 'uri'
+
+module Shorty
+  ShortyError       = Class.new(StandardError)
+  URLConflict       = Class.new(ShortyError)
+  URLFormatError    = Class.new(ShortyError)
+  InvalidResponse   = Class.new(ShortyError)
+  KeyRequiredError  = Class.new(ArgumentError)
+  
+  class Client
+    attr_reader :error
+    
+    def initialize(end_point, &block)
+      @uri = URI.parse(end_point)
+      yield self if block_given?
+    end
+    
+    # Return nil/false if a key couldn't be generated
+    def shorten(url, key=nil)
+      begin
+        shorten!(url, key)
+      rescue => e
+        nil
+      end
+    end
+    
+    # Raise an exception of the url couldn't be shortened
+    def shorten!(url, key=nil)
+      begin
+        key ? named_url(url, key) : autoname_url(url)
+      rescue => e
+        @error = e and raise
+      end
+    end
+    
+    # Gets a new key that was generated by Shorty.
+    def key
+      Net::HTTP.get(@uri.host, "#{@uri.request_uri}key", @uri.port)
+    end
+    
+  protected
+    # PUT the url and a key to Shorty. This is used if you want to specify th
+    # short url key.
+    def named_url(url, key)
+      raise KeyRequiredError("Key required for named short URLs") unless key
+      request('PUT', "#{@uri.request_uri}#{key}", url)
+    end
+    
+    # POST the long url to the server and automatically generate a key. Use
+    # if you don't know or care about the shortened URL key.
+    def autoname_url(url)
+      request('POST', @uri.request_uri, url)
+    end
+    
+    # A more abstraction HTTP request for Shorty
+    def request(method, request_uri, long_url)
+      Net::HTTP.start(@uri.host, @uri.port) do |http|
+        headers = { 'Content-Type' => 'text/plain' }
+        response = http.send_request(method, request_uri, long_url, headers)
+        process_response(response)
+      end
+    end
+    
+    # Processes HTTP responses for Shorty
+    def process_response(response)
+      case response
+        when Net::HTTPFound, Net::HTTPCreated
+          response['Location']
+        when Net::HTTPConflict
+          raise URLConflict
+        when Net::HTTPNotAcceptable
+          raise URLFormatError
+        else
+          raise InvalidResponse.new("Invalid Shorty Response Code: #{response.code} #{response.message}")
+      end
+    end
+  end
+end

data/shorty_client.gemspec

@@ -0,0 +1,55 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{shorty_client}
+  s.version = "0.5.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Brad Gessler"]
+  s.date = %q{2010-05-27}
+  s.description = %q{The shorty client is a convienent wrapper for interacting with your shorty server from your Ruby projects.}
+  s.email = %q{brad@bradgessler.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/shorty/client.rb",
+     "shorty_client.gemspec",
+     "spec/shorty_client_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/bradgessler/shorty_client}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Work with your shorty server from Ruby}
+  s.test_files = [
+    "spec/shorty_client_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+  end
+end
+

data/spec/shorty_client_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "ShortyClient" do
+  it "fails" do
+    fail "hey buddy, you should probably rename this file and start specing for real"
+  end
+end

data/spec/spec.opts

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

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'shorty_client'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification 
+name: shorty_client
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 5
+  - 0
+  version: 0.5.0
+platform: ruby
+authors: 
+- Brad Gessler
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-27 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+description: The shorty client is a convienent wrapper for interacting with your shorty server from your Ruby projects.
+email: brad@bradgessler.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/shorty/client.rb
+- shorty_client.gemspec
+- spec/shorty_client_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/bradgessler/shorty_client
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Work with your shorty server from Ruby
+test_files: 
+- spec/shorty_client_spec.rb
+- spec/spec_helper.rb