shorty_client 0.5.0

Sign up to get free protection for your applications and to get access to all the features.
data/.document ADDED
@@ -0,0 +1,5 @@
1
+ README.rdoc
2
+ lib/**/*.rb
3
+ bin/*
4
+ features/**/*.feature
5
+ LICENSE
data/.gitignore ADDED
@@ -0,0 +1,21 @@
1
+ ## MAC OS
2
+ .DS_Store
3
+
4
+ ## TEXTMATE
5
+ *.tmproj
6
+ tmtags
7
+
8
+ ## EMACS
9
+ *~
10
+ \#*
11
+ .\#*
12
+
13
+ ## VIM
14
+ *.swp
15
+
16
+ ## PROJECT::GENERAL
17
+ coverage
18
+ rdoc
19
+ pkg
20
+
21
+ ## PROJECT::SPECIFIC
data/LICENSE ADDED
@@ -0,0 +1,20 @@
1
+ Copyright (c) 2009 Brad Gessler
2
+
3
+ Permission is hereby granted, free of charge, to any person obtaining
4
+ a copy of this software and associated documentation files (the
5
+ "Software"), to deal in the Software without restriction, including
6
+ without limitation the rights to use, copy, modify, merge, publish,
7
+ distribute, sublicense, and/or sell copies of the Software, and to
8
+ permit persons to whom the Software is furnished to do so, subject to
9
+ the following conditions:
10
+
11
+ The above copyright notice and this permission notice shall be
12
+ included in all copies or substantial portions of the Software.
13
+
14
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
18
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
19
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
data/README.rdoc ADDED
@@ -0,0 +1,27 @@
1
+ = Shorty client
2
+
3
+ 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.
4
+
5
+ Shorty::Client.new "http://my.shorty.server/" do |s|
6
+ if short_url = s.shorten "http://www.google.com/"
7
+ puts "It worked! See it at #{short_url}"
8
+ else
9
+ puts shorty.errors.join(', ')
10
+ end
11
+ end
12
+
13
+ Pretty rad!
14
+
15
+ == Note on Patches/Pull Requests
16
+
17
+ * Fork the project.
18
+ * Make your feature addition or bug fix.
19
+ * Add tests for it. This is important so I don't break it in a
20
+ future version unintentionally.
21
+ * Commit, do not mess with rakefile, version, or history.
22
+ (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)
23
+ * Send me a pull request. Bonus points for topic branches.
24
+
25
+ == Copyright
26
+
27
+ Copyright (c) 2010 Brad Gessler. See LICENSE for details.
data/Rakefile ADDED
@@ -0,0 +1,45 @@
1
+ require 'rubygems'
2
+ require 'rake'
3
+
4
+ begin
5
+ require 'jeweler'
6
+ Jeweler::Tasks.new do |gem|
7
+ gem.name = "shorty_client"
8
+ gem.summary = %Q{Work with your shorty server from Ruby}
9
+ gem.description = %Q{The shorty client is a convienent wrapper for interacting with your shorty server from your Ruby projects.}
10
+ gem.email = "brad@bradgessler.com"
11
+ gem.homepage = "http://github.com/bradgessler/shorty_client"
12
+ gem.authors = ["Brad Gessler"]
13
+ gem.add_development_dependency "rspec", ">= 1.2.9"
14
+ # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
15
+ end
16
+ Jeweler::GemcutterTasks.new
17
+ rescue LoadError
18
+ puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
19
+ end
20
+
21
+ require 'spec/rake/spectask'
22
+ Spec::Rake::SpecTask.new(:spec) do |spec|
23
+ spec.libs << 'lib' << 'spec'
24
+ spec.spec_files = FileList['spec/**/*_spec.rb']
25
+ end
26
+
27
+ Spec::Rake::SpecTask.new(:rcov) do |spec|
28
+ spec.libs << 'lib' << 'spec'
29
+ spec.pattern = 'spec/**/*_spec.rb'
30
+ spec.rcov = true
31
+ end
32
+
33
+ task :spec => :check_dependencies
34
+
35
+ task :default => :spec
36
+
37
+ require 'rake/rdoctask'
38
+ Rake::RDocTask.new do |rdoc|
39
+ version = File.exist?('VERSION') ? File.read('VERSION') : ""
40
+
41
+ rdoc.rdoc_dir = 'rdoc'
42
+ rdoc.title = "shorty_client #{version}"
43
+ rdoc.rdoc_files.include('README*')
44
+ rdoc.rdoc_files.include('lib/**/*.rb')
45
+ end
data/VERSION ADDED
@@ -0,0 +1 @@
1
+ 0.5.0
@@ -0,0 +1,79 @@
1
+ require 'net/http'
2
+ require 'uri'
3
+
4
+ module Shorty
5
+ ShortyError = Class.new(StandardError)
6
+ URLConflict = Class.new(ShortyError)
7
+ URLFormatError = Class.new(ShortyError)
8
+ InvalidResponse = Class.new(ShortyError)
9
+ KeyRequiredError = Class.new(ArgumentError)
10
+
11
+ class Client
12
+ attr_reader :error
13
+
14
+ def initialize(end_point, &block)
15
+ @uri = URI.parse(end_point)
16
+ yield self if block_given?
17
+ end
18
+
19
+ # Return nil/false if a key couldn't be generated
20
+ def shorten(url, key=nil)
21
+ begin
22
+ shorten!(url, key)
23
+ rescue => e
24
+ nil
25
+ end
26
+ end
27
+
28
+ # Raise an exception of the url couldn't be shortened
29
+ def shorten!(url, key=nil)
30
+ begin
31
+ key ? named_url(url, key) : autoname_url(url)
32
+ rescue => e
33
+ @error = e and raise
34
+ end
35
+ end
36
+
37
+ # Gets a new key that was generated by Shorty.
38
+ def key
39
+ Net::HTTP.get(@uri.host, "#{@uri.request_uri}key", @uri.port)
40
+ end
41
+
42
+ protected
43
+ # PUT the url and a key to Shorty. This is used if you want to specify th
44
+ # short url key.
45
+ def named_url(url, key)
46
+ raise KeyRequiredError("Key required for named short URLs") unless key
47
+ request('PUT', "#{@uri.request_uri}#{key}", url)
48
+ end
49
+
50
+ # POST the long url to the server and automatically generate a key. Use
51
+ # if you don't know or care about the shortened URL key.
52
+ def autoname_url(url)
53
+ request('POST', @uri.request_uri, url)
54
+ end
55
+
56
+ # A more abstraction HTTP request for Shorty
57
+ def request(method, request_uri, long_url)
58
+ Net::HTTP.start(@uri.host, @uri.port) do |http|
59
+ headers = { 'Content-Type' => 'text/plain' }
60
+ response = http.send_request(method, request_uri, long_url, headers)
61
+ process_response(response)
62
+ end
63
+ end
64
+
65
+ # Processes HTTP responses for Shorty
66
+ def process_response(response)
67
+ case response
68
+ when Net::HTTPFound, Net::HTTPCreated
69
+ response['Location']
70
+ when Net::HTTPConflict
71
+ raise URLConflict
72
+ when Net::HTTPNotAcceptable
73
+ raise URLFormatError
74
+ else
75
+ raise InvalidResponse.new("Invalid Shorty Response Code: #{response.code} #{response.message}")
76
+ end
77
+ end
78
+ end
79
+ end
@@ -0,0 +1,55 @@
1
+ # Generated by jeweler
2
+ # DO NOT EDIT THIS FILE DIRECTLY
3
+ # Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
4
+ # -*- encoding: utf-8 -*-
5
+
6
+ Gem::Specification.new do |s|
7
+ s.name = %q{shorty_client}
8
+ s.version = "0.5.0"
9
+
10
+ s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
11
+ s.authors = ["Brad Gessler"]
12
+ s.date = %q{2010-05-27}
13
+ s.description = %q{The shorty client is a convienent wrapper for interacting with your shorty server from your Ruby projects.}
14
+ s.email = %q{brad@bradgessler.com}
15
+ s.extra_rdoc_files = [
16
+ "LICENSE",
17
+ "README.rdoc"
18
+ ]
19
+ s.files = [
20
+ ".document",
21
+ ".gitignore",
22
+ "LICENSE",
23
+ "README.rdoc",
24
+ "Rakefile",
25
+ "VERSION",
26
+ "lib/shorty/client.rb",
27
+ "shorty_client.gemspec",
28
+ "spec/shorty_client_spec.rb",
29
+ "spec/spec.opts",
30
+ "spec/spec_helper.rb"
31
+ ]
32
+ s.homepage = %q{http://github.com/bradgessler/shorty_client}
33
+ s.rdoc_options = ["--charset=UTF-8"]
34
+ s.require_paths = ["lib"]
35
+ s.rubygems_version = %q{1.3.6}
36
+ s.summary = %q{Work with your shorty server from Ruby}
37
+ s.test_files = [
38
+ "spec/shorty_client_spec.rb",
39
+ "spec/spec_helper.rb"
40
+ ]
41
+
42
+ if s.respond_to? :specification_version then
43
+ current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
44
+ s.specification_version = 3
45
+
46
+ if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
47
+ s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
48
+ else
49
+ s.add_dependency(%q<rspec>, [">= 1.2.9"])
50
+ end
51
+ else
52
+ s.add_dependency(%q<rspec>, [">= 1.2.9"])
53
+ end
54
+ end
55
+
@@ -0,0 +1,7 @@
1
+ require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
2
+
3
+ describe "ShortyClient" do
4
+ it "fails" do
5
+ fail "hey buddy, you should probably rename this file and start specing for real"
6
+ end
7
+ end
data/spec/spec.opts ADDED
@@ -0,0 +1 @@
1
+ --color
@@ -0,0 +1,9 @@
1
+ $LOAD_PATH.unshift(File.dirname(__FILE__))
2
+ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
3
+ require 'shorty_client'
4
+ require 'spec'
5
+ require 'spec/autorun'
6
+
7
+ Spec::Runner.configure do |config|
8
+
9
+ end
metadata ADDED
@@ -0,0 +1,87 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: shorty_client
3
+ version: !ruby/object:Gem::Version
4
+ prerelease: false
5
+ segments:
6
+ - 0
7
+ - 5
8
+ - 0
9
+ version: 0.5.0
10
+ platform: ruby
11
+ authors:
12
+ - Brad Gessler
13
+ autorequire:
14
+ bindir: bin
15
+ cert_chain: []
16
+
17
+ date: 2010-05-27 00:00:00 -07:00
18
+ default_executable:
19
+ dependencies:
20
+ - !ruby/object:Gem::Dependency
21
+ name: rspec
22
+ prerelease: false
23
+ requirement: &id001 !ruby/object:Gem::Requirement
24
+ requirements:
25
+ - - ">="
26
+ - !ruby/object:Gem::Version
27
+ segments:
28
+ - 1
29
+ - 2
30
+ - 9
31
+ version: 1.2.9
32
+ type: :development
33
+ version_requirements: *id001
34
+ description: The shorty client is a convienent wrapper for interacting with your shorty server from your Ruby projects.
35
+ email: brad@bradgessler.com
36
+ executables: []
37
+
38
+ extensions: []
39
+
40
+ extra_rdoc_files:
41
+ - LICENSE
42
+ - README.rdoc
43
+ files:
44
+ - .document
45
+ - .gitignore
46
+ - LICENSE
47
+ - README.rdoc
48
+ - Rakefile
49
+ - VERSION
50
+ - lib/shorty/client.rb
51
+ - shorty_client.gemspec
52
+ - spec/shorty_client_spec.rb
53
+ - spec/spec.opts
54
+ - spec/spec_helper.rb
55
+ has_rdoc: true
56
+ homepage: http://github.com/bradgessler/shorty_client
57
+ licenses: []
58
+
59
+ post_install_message:
60
+ rdoc_options:
61
+ - --charset=UTF-8
62
+ require_paths:
63
+ - lib
64
+ required_ruby_version: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - ">="
67
+ - !ruby/object:Gem::Version
68
+ segments:
69
+ - 0
70
+ version: "0"
71
+ required_rubygems_version: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - ">="
74
+ - !ruby/object:Gem::Version
75
+ segments:
76
+ - 0
77
+ version: "0"
78
+ requirements: []
79
+
80
+ rubyforge_project:
81
+ rubygems_version: 1.3.6
82
+ signing_key:
83
+ specification_version: 3
84
+ summary: Work with your shorty server from Ruby
85
+ test_files:
86
+ - spec/shorty_client_spec.rb
87
+ - spec/spec_helper.rb