supr 0.1.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 Blake Chambers
+
+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.markdown

@@ -0,0 +1,57 @@
+Supr
+====
+
+Supr is a gem wrapping [Stumble Upon][su]'s [Su.pr][supr] url shortening service.  The api is relatively new 
+and thin on features, but this gem gives you access to the shorten and expand methods.  More 
+support for the post method is planned.  Statistic information is still covered by the api 
+but when that is exposed, it will be added here. 
+
+**Supr uses [semantic versioning][semvar] and the api should be considered unstable until version 1.0.0. 
+*Consider yourself warned*.**
+
+Installation
+------------
+
+gem install supr
+
+Usage
+-----
+
+Create a Bitly client using your username and api key as follows:
+
+supr\_client = Supr.new(username, api_key)
+
+You can then use that client to shorten or expand urls as so:
+
+supr\_client.shorten('http://www.google.com')
+supr\_client.shorten('http://www.google.com')
+supr\_client.expand('xJs4E')
+
+Special Thanks
+--------------
+
+This gem is mostly based on the [bitly gem][bitly] written by [Phil Nash][phil].  Special
+thanks to him for the code base to start with.  
+
+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 Blake Chambers. See LICENSE for details.
+
+[phil]:   http://github.com/philnash
+[bitly]:  http://github.com/philnash/bitly
+[semvar]: http://semver.org/
+[su]:     http://www.stumbleupon.com/ "Stumble Upon"
+[supr]:   http://su.pr/ "Su.pr"

data/Rakefile

@@ -0,0 +1,49 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "supr"
+    gem.summary = %Q{Use the su.pr API to shorten or expand URLs}
+    gem.description = %Q{Use the su.pr API to shorten or expand URLs}
+    gem.email = "chambb1@gmail.com"
+    gem.homepage = "http://github.com/blakechambers/supr"
+    gem.authors = ["Blake Chambers"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "yard", ">= 0"
+    
+    gem.add_dependency 'crack',    '>= 0.1.4'
+    gem.add_dependency 'httparty', '>= 0.5.2'
+    
+    # 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
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/supr.rb

@@ -0,0 +1,8 @@
+$:.unshift File.dirname(__FILE__)
+
+require 'crack'
+
+require 'supr/utils'
+require 'supr/client'
+require 'supr/url'
+require 'supr/version'

data/lib/supr/client.rb

@@ -0,0 +1,129 @@
+require 'rubygems'
+require 'net/http'
+require 'uri'
+
+module Supr
+  API_URL     = 'http://su.pr/api/'
+  API_VERSION = '1.0'
+
+  def self.new(login, api_key)
+    Supr::Client.new(login,api_key)
+  end
+
+  class Client
+    
+    include Supr::Utils
+    
+    def initialize(login,api_key)
+      @login = login
+      @api_key = api_key
+    end
+
+    def shorten(input, opts={})
+      if input.is_a? String
+        request = create_url("shorten", :longUrl => input, :history => (opts[:history] ? 1 : nil))
+        result = get_result(request)
+        result = {:long_url => input}.merge result[input]
+        Supr::Url.new(@login,@api_key,result)
+      elsif input.is_a? Array
+        request = create_url("shorten", :history => (opts[:history] ? 1 : nil))
+        request.query << "&" + input.map { |long_url| "longUrl=#{CGI.escape(long_url)}" }.join("&") unless input.nil?
+        result = get_result(request)
+        input.map do |long_url|
+          new_url = {:long_url => long_url}.merge result[long_url]
+          long_url = Supr::Url.new(@login,@api_key,new_url)
+        end
+      else
+        raise ArgumentError.new("Shorten requires either a url or an array of urls")
+      end
+    end
+    
+    def validate
+      @validated ||= begin
+        self.shorten("http://google.com").kind_of?(::Supr::Url)
+      rescue
+        false
+      end
+    end
+    alias :valid? :validate
+    
+    def expand(input)
+      if input.is_a? String
+        if input.include?('su.pr/') || input.include?('j.mp/')
+          hash = create_hash_from_url(input)
+          request = create_url "expand", :hash => hash
+          result = get_result(request)
+          result = { :short_url => input, :hash => hash }.merge result[hash]
+        else
+          request = create_url "expand", :hash => input
+          result = get_result(request)
+          result = { :hash => input, :short_url => "http://su.pr/#{input}" }.merge result[input]
+        end
+        Supr::Url.new(@login,@api_key,result)        
+      elsif input.is_a? Array
+        request = create_url "expand", :hash => input.join(',')
+        result = get_result(request)
+        input.map do |hsh|
+          new_url = {:hash => hsh, :short_url => "http://su.pr/#{hsh}"}.merge result[hsh]
+          hsh = Supr::Url.new(@login,@api_key,new_url)
+        end
+      else
+        raise ArgumentError('Expand requires either a short url, a hash or an array of hashes')
+      end
+    end
+    
+    # def info(input)
+    #   if input.is_a? String
+    #     if input.include? "su.pr/"
+    #       hash = create_hash_from_url(input)
+    #       request = create_url 'info', :hash => hash
+    #       result = get_result(request)
+    #       result = { :short_url => "http://su.pr/#{hash}", :hash => hash }.merge result[hash]
+    #     else
+    #       request = create_url 'info', :hash => input
+    #       result = get_result(request)
+    #       result = { :short_url => "http://su.pr/#{input}", :hash => input }.merge result[input]
+    #     end
+    #     Supr::Url.new(@login,@api_key,result)
+    #   elsif input.is_a? Array
+    #     request = create_url "info", :hash => input.join(',')
+    #     result = get_result(request)
+    #     input.map do |hsh|
+    #       new_url = {:hash => hsh, :short_url => "http://su.pr/#{hsh}"}.merge result[hsh]
+    #       hsh = Supr::Url.new(@login,@api_key,:info => new_url)
+    #     end
+    #   else
+    #     raise ArgumentError.new('Info requires either a short url, a hash or an array of hashes')
+    #   end
+    # end
+    # 
+    # def stats(input)
+    #   if input.is_a? String
+    #     if input.include? "su.pr/"
+    #       hash = create_hash_from_url(input)
+    #       request = create_url 'stats', :hash => hash
+    #       result = get_result(request)
+    #       result = { :short_url => "http://su.pr/#{hash}", :hash => hash }.merge result
+    #     else
+    #       request = create_url 'stats', :hash => input
+    #       result = get_result(request)
+    #       result = { :short_url => "http://su.pr/#{input}", :hash => input }.merge result
+    #     end
+    #     Supr::Url.new(@login,@api_key,:stats => result)
+    #   else
+    #     raise ArgumentError.new("Stats requires either a short url or a hash")
+    #   end
+    # end
+    
+  end
+  
+end
+
+class SuprError < StandardError
+  attr_reader :code
+  alias :msg :message
+  def initialize(msg, code)
+    @code = code
+    super("#{msg} - '#{code}'")
+  end
+end

data/lib/supr/url.rb

@@ -0,0 +1,96 @@
+module Supr
+  
+  class Url
+    include Supr::Utils
+    
+    attr_accessor :long_url, :short_url, :hash
+    attr_reader :info, :stats
+    VARIABLES = ['long_url', 'short_url', 'hash']
+    
+    def initialize(login,api_key,obj=nil)
+      unless obj.nil?
+        raise SuprError.new(obj['errorMessage'],obj['errorCode']) if obj['statusCode'] == "ERROR"
+        instance_variablise(obj, VARIABLES)
+        @info = obj[:info] if obj[:info]
+        @stats = obj[:stats] if obj[:stats]
+      end
+      @login = login
+      @api_key = api_key
+      raise ArgumentError.new("Please provide a login and api_key") if @login.nil? || @api_key.nil?
+    end
+    
+    def shorten(opts = {})
+      return @short_url if @short_url
+      unless @long_url.nil?
+        request = create_url("shorten", :longUrl => @long_url, :history => (opts[:history] ? 1 : nil))
+        result = get_result(request)[@long_url.gsub(/\/$/,'')]
+        if result['statusCode'] == "ERROR"
+          raise SuprError.new(result['errorMessage'],result['errorCode'])
+        else
+          instance_variablise(result,VARIABLES)
+          return @short_url
+        end
+      else
+        raise ArgumentError.new("You need a long_url in order to shorten it")
+      end
+    end
+    
+    def expand
+      return @long_url if @long_url
+      unless !(@short_url || @hash)
+        unless @hash
+          @hash = create_hash_from_url(@short_url)
+        end
+        request = create_url("expand", :hash => @hash)
+        result = get_result(request)[@hash]
+        if result['statusCode'] == "ERROR"
+          raise SuprError.new(result['errorMessage'],result['errorCode'])
+        else
+          instance_variablise(result,VARIABLES)
+          return @long_url
+        end
+      else
+        raise ArgumentError.new("You need a short_url or a hash in order to expand it")
+      end
+    end
+    
+    # def info
+    #   if @info.nil?
+    #     if @hash
+    #       request = create_url "info", :hash => @hash
+    #       result = get_result(request)[@hash]
+    #       instance_variablise(result, VARIABLES)
+    #       @info = result
+    #     elsif @short_url
+    #       @hash = create_hash_from_url(@short_url)
+    #       request = create_url "info", :hash => hash
+    #       result = get_result(request)[hash]
+    #       instance_variablise(result, VARIABLES)
+    #       @info = result
+    #     else
+    #       raise ArgumentError.new("You need a hash or short_url in order to get info")
+    #     end
+    #     return @info
+    #   else
+    #     @info
+    #   end
+    # end
+    # 
+    # def stats
+    #   if @stats.nil?
+    #     if @hash
+    #       request = create_url "stats", :hash => @hash
+    #     elsif @short_url
+    #       @hash = create_hash_from_url(@short_url)
+    #       request = create_url "stats", :hash => @hash
+    #     else
+    #       raise ArgumentError.new("You need a hash or short_url in order to get stats")
+    #     end
+    #     @stats = get_result(request)
+    #   else
+    #     @stats
+    #   end
+    # end
+  end
+
+end

data/lib/supr/utils.rb

@@ -0,0 +1,60 @@
+require 'cgi'
+
+module Supr
+  module Utils
+    def underscore(camel_cased_word) # stolen from rails
+      camel_cased_word.to_s.gsub(/::/, '/').
+      gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+      gsub(/([a-z\d])([A-Z])/,'\1_\2').
+      tr("-", "_").
+      downcase
+    end
+    
+    def create_hash_from_url(url)
+      url.gsub(/^.*(bit\.ly|j\.mp)\//,'')
+    end
+    
+    def attr_define(k,v)
+      instance_variable_set("@#{k}", v)
+      meta = class << self; self; end
+      meta.class_eval { attr_reader k.to_sym }
+    end
+
+    def instance_variablise(obj,variables)
+      if obj.is_a? Hash
+        obj.each do |k,v|
+          if v.is_a? Hash
+            instance_variablise(v,variables)
+          else
+            attr_define(underscore(k),v) if variables.include?(underscore(k))
+          end
+        end
+      end
+    end
+    
+    def create_url(resource="",args={})
+      args = args.merge({:login => @login, :apiKey => @api_key, :version => API_VERSION})
+      url = URI.join(API_URL,resource)
+      long_urls = args.delete(:long_urls)
+      url.query = args.map { |k,v| "%s=%s" % [CGI.escape(k.to_s), CGI.escape(v.to_s)] }.join("&")
+      url.query << "&" + long_urls.map { |long_url| "longUrl=#{CGI.escape(long_url)}" }.join("&") unless long_urls.nil?
+      url
+    end
+    
+    def get_result(request)
+      begin
+        json = Net::HTTP.get(request)
+        # puts json.inspect
+        result = Crack::JSON.parse(json)
+      rescue
+        result = {'errorMessage' => 'JSON Parse Error(Bit.ly messed up)', 'errorCode' => 69, 'statusCode' => 'ERROR'}
+      end
+      if result['statusCode'] == "OK"
+        result = result['results']
+      else
+        raise SuprError.new(result['errorMessage'],result['errorCode'])
+      end
+    end
+    
+  end
+end

data/lib/supr/version.rb

@@ -0,0 +1,3 @@
+module Supr
+  VERSION = '0.1.0'
+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 'supr'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

data/spec/supr_spec.rb

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

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification 
+name: supr
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Blake Chambers
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-04 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !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: *id001
+- !ruby/object:Gem::Dependency 
+  name: yard
+  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: crack
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 0
+        - 1
+        - 4
+        version: 0.1.4
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id004 !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: *id004
+description: Use the su.pr API to shorten or expand URLs
+email: chambb1@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- lib/supr.rb
+- lib/supr/client.rb
+- lib/supr/url.rb
+- lib/supr/utils.rb
+- lib/supr/version.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/supr_spec.rb
+has_rdoc: true
+homepage: http://github.com/blakechambers/supr
+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: Use the su.pr API to shorten or expand URLs
+test_files: 
+- spec/spec_helper.rb
+- spec/supr_spec.rb