gadafi 0.0.2

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in gadafi.gemspec
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (C) 2011 by Chris Adams <wave@chrisadams.me.uk>
+
+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,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/bin/gadafi

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'gadafi/cli'
+Gadafi::CLI.start
+

data/features/cli_url_shortening.feature

@@ -0,0 +1,10 @@
+Feature: Gadafi
+  In order to quickly shorten urls
+  As a CLI
+  I want to shorten urls on the commandline
+
+Scenario: Gadafi gives me a short url back
+    When I run "gadafi http://en.wikipedia.org/wiki/URL_shortening"
+    Then the output should contain "http://www.gadaf.fi/1"
+  
+

data/features/setup.rb

@@ -0,0 +1 @@
+require 'aruba/cucumber'

data/gadafi.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "gadafi/version"
+
+Gem::Specification.new do |s|
+  s.name        = "gadafi"
+  s.version     = Gadafi::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Chris Adams"]
+  s.email       = ["wave@chrisadams.me.uk"]
+  s.homepage    = "http://chrisdams.me.uk"
+  s.summary     = %q{A simple wrapper for the gadaf.fi url shortening service.}
+  s.description = %q{This gem was written largely to get familiar with aruba, and minitest, bundler and thor when making gems with a CLI}
+
+  s.rubyforge_project = "gadafi"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  s.add_development_dependency "minitest"
+  s.add_development_dependency "cucumber"
+  s.add_development_dependency "aruba"
+  s.add_development_dependency "ruby-debug"
+  s.add_development_dependency "rake"
+  s.add_dependency "rest-client"
+  s.add_dependency "thor"
+end

data/lib/gadafi/cli.rb

@@ -0,0 +1,23 @@
+require 'thor'
+require 'gadafi/gadafi'
+require 'ruby-debug'
+
+module Gadafi
+
+  class CLI < Thor
+
+      desc 'shorten', 'fetch a shortened url'
+      def shorten url
+        g = Gadafi.new
+        puts g.short_url url
+      end
+
+      def method_missing argument
+        shorten argument
+      end
+
+  end
+
+end
+
+

data/lib/gadafi/gadafi.rb

@@ -0,0 +1,12 @@
+require 'rest-client'
+
+module Gadafi
+
+  class Gadafi
+    
+      def short_url url
+        RestClient.get("http://gadaf.fi/api.php?url=#{url}")
+      end
+
+  end
+end

data/lib/gadafi/version.rb

@@ -0,0 +1,3 @@
+module Gadafi
+  VERSION = "0.0.2"
+end

data/readme.md

@@ -0,0 +1,48 @@
+#  gadafi gem
+
+This gem is a simple wrapper around the gadafi url shortening service, available at [http://gadaf.fi].
+
+## Installation
+
+As with most ruby gems, just type this on the command line.
+
+    $ gem install gadafi
+
+## Usage
+
+It's a pretty simple gem - just paste in the url you want to shorten, and it'll print the url for the short url to STDOUT:
+
+    $ gadafi http://en.wikipedia.org/wiki/URL_shortening        # http://www.gadaf.fi/1
+
+## TODO / Thoughts
+
+* I largely created it as a an exercise to help me learn how to make gems using bundler, by following along [this tutorial here][] by [radar][].
+* I'm aware that this gem is a somewhat comical example of over-engineering - this could be accomplished much quicker by simply using an alias to curl for example, but the aim of this gem was learning how to make gems, rather than development minimalism :)
+* It uses minitest instead of rspec for testing, but otherwise, I've tried to follow it fairly faithfully.
+* I don't really expect any, but if you find this useful, I'd be happy to take feature requests, and pull requests.
+* TODO use mocks with the tests to stop hitting an actual api endpoint.
+* TODO use a local storage of some kind to cache already queried urls.  Suggestions welcome!
+
+
+# Author
+
+* [Chris Adams][] 
+
+## License
+
+[MIT LICENSE][]
+
+# Thanks 
+
+[Christoffer Bjorkskog][] - for making a cool url service in the first place
+[Ryan Bigg][] (on github as [radar][]) - for making such a great guide to follow.
+
+<!-- links -->
+
+[Christoffer Bjorkskog]: http://toffe.wordpress.com
+[Chris Adams]: http://chrisadams.me.uk
+[this tutorial here]: https://github.com/radar/guides/blob/master/gem-development.md
+[MIT LICENSE]: https://github.com/mrchrisadams/gadafi/blob/master/MIT-LICENSE
+[Ryan Bigg]: https://github.com/radar
+[radar]: https://github.com/radar
+

data/test/gadafi_test.rb

@@ -0,0 +1,34 @@
+require 'minitest/autorun'
+require 'gadafi/gadafi'
+
+
+describe Gadafi::Gadafi do
+
+  before do
+    @gadafi = Gadafi::Gadafi.new
+    @long_url = "http://en.wikipedia.org/wiki/URL_shortening"
+    @short_url = "http://www.gadaf.fi/1"
+  end
+
+  describe "when passed a full length valid url" do
+    it "must respond with a shortcode url" do
+      @gadafi.short_url(@long_url).must_equal @short_url
+    end
+
+    it "must return an okay status code" do
+      @gadafi.short_url(@long_url).code.must_equal 200
+    end
+
+  end
+
+  describe "when passed a bad url" do
+    it "must not return an ok status code" do
+      skip
+      @gadafi.short_url("not an url").code.wont_equal 200
+
+    end
+
+  end
+
+end
+

metadata

@@ -0,0 +1,179 @@
+--- !ruby/object:Gem::Specification 
+name: gadafi
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Chris Adams
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-14 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: minitest
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: aruba
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: ruby-debug
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: thor
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id007
+description: This gem was written largely to get familiar with aruba, and minitest, bundler and thor when making gems with a CLI
+email: 
+- wave@chrisadams.me.uk
+executables: 
+- gadafi
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- MIT-LICENSE
+- Rakefile
+- bin/gadafi
+- features/cli_url_shortening.feature
+- features/setup.rb
+- gadafi.gemspec
+- lib/gadafi/cli.rb
+- lib/gadafi/gadafi.rb
+- lib/gadafi/version.rb
+- readme.md
+- test/gadafi_test.rb
+has_rdoc: true
+homepage: http://chrisdams.me.uk
+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: gadafi
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: A simple wrapper for the gadaf.fi url shortening service.
+test_files: 
+- features/cli_url_shortening.feature
+- features/setup.rb
+- test/gadafi_test.rb