short 0.4.3 → 0.5.0

data/README.md

@@ -9,13 +9,20 @@ for obvious reasons, the demo is configured with S3 disabled. However, if you ar
 to play around with `short` follow the instructions below and use `http://shortener1.heroku.com`
 as your the url you want to use.
 
+## Upgrading to 0.5.0
+
+v0.5.0 updates how shortener stores some data. To assist in keeping your data,
+v0.5.0 also provides a `rake short:data:dehyphenate_keys` task that will update
+your existing data to the new schema. If have data from < 0.5 that you plan on
+using in a >= 0.5 world, you should run this task.
+
 ### Installation
 
-is now as easy as 
+is now as easy as
 
 `gem install short`
 
-and 
+and
 
 `short`
 
@@ -84,7 +91,7 @@ the `Shortener` class or directly through the `Shortener::Short` class. You get:
 * fetch
 * delete
 
-methods, each of which will return a/n istance of the `Short` class which will 
+methods, each of which will return a/n istance of the `Short` class which will
 parse the data and provide some defaults and access to said data.
 
 ### Executable

data/bin/short

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
-$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/../lib')
+$: << File.expand_path(File.dirname(__FILE__) + '/../lib')
 
 require 'shortener'
 
@@ -89,11 +89,11 @@ shorts: #{index.length}
 EOD
 end
 
-def rake(arg)
-  puts "running shortener rake task: #{arg}"
+def build
   gem_dir = File.expand_path(File.dirname(File.dirname(__FILE__)))
-  cmd = "cd #{gem_dir} && rake #{arg}"
-  puts `#{cmd}`
+  require 'rake'; load 'shortener/tasks/heroku.rake'
+  Rake::Task[:'short:heroku:build'].execute
+  puts "Your shortener repo has been created, cd there to finish up the process"
 end
 
 def do_action(act, arg)
@@ -114,7 +114,7 @@ def usage
     delete:   delete a short from the index.
     index:    show summary data for all shorts.
 
-    rake:     run a shortener rake task. [heroku:build, heroku:setup...]
+    build:    Generate a shortener server folder.
     server:   start an instance of the shortener server locally.
 
   the default command is shorten, so that one could
@@ -167,8 +167,9 @@ when 'server'
   start_web
 when 'index'
   show_index
-when 'rake'
-  do_action(:rake, ARGV[1])
+when 'build'
+  #do_action(:build, ARGV[1])
+  build
 when 'delete'
   do_action(:delete, ARGV[1])
 when '-v', '--version'

data/lib/shortener/configuration.rb

@@ -1,5 +1,6 @@
 require 'uri'
 require 'yaml'
+require 'redis-namespace'
 
 class Shortener
   # The class for storing Configuration Information
@@ -15,7 +16,7 @@ class Shortener
 
     OPTIONS = [:SHORTENER_URL, :DEFAULT_URL, :REDISTOGO_URL, :S3_KEY_PREFIX,
       :S3_ACCESS_KEY_ID, :S3_SECRET_ACCESS_KEY, :S3_DEFAULT_ACL, :S3_BUCKET,
-      :DOTFILE_PATH, :S3_ENABLED]
+      :DOTFILE_PATH, :S3_ENABLED, :SHORTENER_NS]
 
     HEROKU_IGNORE = [:DOTFILE_PATH, :SHORTENER_URL, :REDISTOGO_URL]
 
@@ -32,6 +33,7 @@ class Shortener
         check_env
         @options = @options.merge!(opts)
         @options[:DEFAULT_URL] ||= '/index'
+        @options[:SHORTENER_NS] ||= :shortener
       else
         @options = Configuration.current.options
       end
@@ -61,6 +63,14 @@ class Shortener
         @options[opt]
       end
     end
+    alias ns shortener_ns
+
+    # a configured redis namespace instance
+    def redis
+      uri = self.redistogo_url
+      _r = Redis.new(:host => uri.host, :port => uri.port, :password => uri.password)
+      Redis::Namespace.new(self.ns, redis: _r)
+    end
 
     # return the URI for the redistogo url
     def redistogo_url
@@ -82,7 +92,7 @@ class Shortener
     # are the necessary options present for S3 to work?
     def s3_configured
       ret = true
-      [:S3_KEY_PREFIX, :S3_ACCESS_KEY_ID, :S3_SECRET_ACCESS_KEY, 
+      [:S3_KEY_PREFIX, :S3_ACCESS_KEY_ID, :S3_SECRET_ACCESS_KEY,
         :S3_DEFAULT_ACL, :S3_BUCKET ].each do |k|
         ret = !@options[k].nil? unless ret == false
       end

data/lib/shortener/server/views/index.haml

@@ -14,8 +14,8 @@
           %td= short['shortened']
           %td
             %a{href: short['url']}= short['url'][0..50] + ((short['url'].length > 50) ? '...' : '')
-          %td= short['set-count']
-          %td= short['click-count'] || 0
+          %td= short['set_count']
+          %td= short['click_count'] || 0
           %td= ttl_display(short['expire'])
           %td= short['max-clicks'] || "∞"
           %td

data/lib/shortener/server.rb

@@ -92,7 +92,7 @@ class Shortener
         url = "https://s3.amazonaws.com/#{$conf.s3_bucket}/#{$conf.s3_key_prefix}/#{fname}"
         ext = File.extname(fname)[1..-1]
         data = {'url' => url, 's3' => true, 'shortened' => key,
-          'extension' => ext, 'set-count' => 1}
+          'extension' => ext, 'set_count' => 1}
         data = params.merge(data)
 
         $redis.set(key, sha)
@@ -117,7 +117,7 @@ class Shortener
             unless options['expire'] || options['max-clicks']
               if (!prev_set['max-clicks'] && !prev_set['expire'] &&
                 (prev_set['url'] == url.to_s))
-                $redis.hincrby(check_key, 'set-count', 1)
+                $redis.hincrby(check_key, 'set_count', 1)
                 return prev_set
               end
             end
@@ -138,7 +138,7 @@ class Shortener
         sha = Digest::SHA1.hexdigest(url.to_s)
         $redis.set(key, sha)
 
-        hsh_data = {'shortened' => key, 'url' => url, 'set-count' => 1}
+        hsh_data = {'shortened' => key, 'url' => url, 'set_count' => 1}
         hsh_data['max-clicks'] = options['max-clicks'].to_i if options['max-clicks']
 
         if options['expire'] # set expire time if specified
@@ -159,7 +159,7 @@ class Shortener
         $redis.keys("data:#{sha}:*").each do |key|
           short = $redis.hgetall(key)
           unless short == {} || short['expire'] || short['max-clicks']
-            $redis.hincrby(key, 'set-count', 1)
+            $redis.hincrby(key, 'set_count', 1)
             return short
           end
         end
@@ -277,14 +277,14 @@ class Shortener
         key = "data:#{sha}:#{id}"
         short = $redis.hgetall(key)
         not_expired = short.has_key?('expire') ? $redis.get(short['expire']) : true
-        not_maxed = !(short['click-count'].to_i >= short['max-clicks'].to_i)
+        not_maxed = !(short['click_count'].to_i >= short['max-clicks'].to_i)
         short.has_key?('max-clicks') ? not_maxed : not_maxed = true
         if params[:captures].last == '.json'
           ret = short.merge({expired: not_expired.nil? , maxed: !not_maxed})
           content_type :json
           return ret.to_json
         else
-          $redis.hincrby(key, 'click-count', 1) if not_expired && not_maxed
+          $redis.hincrby(key, 'click_count', 1) if not_expired && not_maxed
           if not_expired
             unless short['s3'] == 'true' && !(short['type'] == 'download')
               if not_maxed

data/lib/shortener/tasks/heroku.rake

@@ -0,0 +1,178 @@
+
+namespace :short do
+
+  namespace :heroku do
+    $gem_dir = File.expand_path(File.dirname(File.dirname(__FILE__)))
+
+    def gem_file(f)
+      #ret = args.map {|f| File.join($gem_dir, f)}.join(" ")
+      File.join($gem_dir, f.to_s)
+    end
+
+    def _file(f)
+      fs = $existing_repo ? [f.to_s] : ['heroku', f.to_s]
+      File.join(Dir.pwd, *fs)
+    end
+
+    def _ep(f)
+      beginning_int = case f.split('/')[-3]
+      when 'shortener'
+        puts "************short" if ENV['VVERBOSE']
+        -2
+      when 'public', 'views', 's3'
+        puts "************public || s3" if ENV['VVERBOSE']
+        -4
+      when 'skin'
+        puts "************views" if ENV['VVERBOSE']
+        -5
+      else
+        puts "************else #{f.split('/')[-3]}" if ENV['VVERBOSE']
+        -3
+      end
+      end_point = f.split('/')[beginning_int..-1].join('/')
+    end
+
+    def _l(action, start, nd = nil)
+      if ENV['VERBOSE']
+        msg = "#{action}: #{start} "
+        msg += "=> #{nd}" unless nd.nil?
+        puts msg 
+      end
+    end
+
+    def recursively_remove_files(dir)
+      dirs = Array.new
+      Dir[File.join(dir, '*')].each do |f|
+        next if f =~ /^(\.|\..*)/
+        if File.directory?(f)
+          if Dir.entries(f).empty?
+            _l(:removing_dir, f)
+            FileUtils.rmdir(f)
+          else
+            dirs << f
+            recursively_remove_files(f)
+          end
+        else
+          _l(:removing, f)
+          FileUtils.rm(f)
+        end
+      end
+      _l(:removing_dir, dirs)
+      FileUtils.rmdir(dirs)
+    end
+
+    desc "Build a Heroku Ready Git repo"
+    task :build do
+      FileUtils.mkdir(File.join(Dir.pwd, 'heroku')) unless $existing_repo
+      [:'server', :'server/public', :'server/views', 
+       :'server/views/s3', :'server/public/flash', 
+       :'server/public/skin', :'server/public/images', 
+       :'server/public/skin/blue.monday'].each do |f|
+        unless File.exist?(_file(f))
+          puts "creating #{_file(f)}" if ENV['VERBOSE']
+          FileUtils.mkdir(_file(f)) 
+        end
+      end
+
+      ['server', 'server/public', 'server/views', :'server/views/s3',
+       :'server/public/flash', :'server/public/images', :'server/public/skin', 
+       :'server/public/skin/blue.monday'].each do |end_point|
+        Dir["#{$gem_dir}/#{end_point}/**"].each do |f|
+          next if File.directory?(f)
+          end_point = _file(:"#{_ep(f)}")
+          _l(:copying, f, end_point)
+          FileUtils.cp(f, end_point)
+        end
+      end
+      _s, _e = gem_file('server.rb'), _file(:'main.rb')
+      _l(:copying, _s, _e)
+      FileUtils.cp(_s, _e)
+      _s, _e = gem_file('configuration.rb'), _file(:'configuration.rb')
+      _l(:copying, _s, _e)
+      FileUtils.cp(_s, _e)
+      _s, _e = _file('server/config.ru.template'), _file(:'config.ru')
+      _l(:renaming, _s, _e)
+      FileUtils.mv(_s, _e)
+      _s, _e = _file('server/Gemfile'), _file(:'Gemfile')
+      _l(:renaming, _s, _e)
+      FileUtils.mv(_s, _e)
+      _s, _e = _file(:'server/Gemfile.lock'), _file(:'Gemfile.lock')
+      _l(:renaming, _s, _e)
+      FileUtils.mv(_s, _e)
+      File.open(_file(:Rakefile), 'w+') do |f|
+        f.puts "load 'shortener/tasks/heroku.rake'"
+      end 
+    end
+
+    desc "initialize the Git repo"
+    task :git do
+      cmd = "git init heroku && cd heroku && git add . && git commit -m initial"
+      sh cmd
+    end
+
+    desc "update with latest gem files"
+    task :update do
+      if `git status` =~ /.*working directory clean.*/
+        recursively_remove_files(Dir.pwd)
+      else
+        puts "working directory not clean, stash or commit your changes"
+      end
+      $existing_repo = true
+      Rake::Task[:'short:heroku:build'].execute
+    end
+
+    desc "config a Heroku app the way we need it. Optionally set APPNAME to set heroku app name"
+    task :config do
+      require 'shortener'
+      $name = ENV['APPNAME'] || "shner-#{`whoami`.chomp}"
+      cmd = Dir.pwd =~ /heroku$/ ? "" : "cd heroku && "
+      cmd += "heroku create #{$name}"
+      cmd += " && heroku addons:add redistogo:nano"
+      cmd += " && heroku config:add #{Shortener::Configuration.new.to_params}"
+      cmd += " && heroku addons:add custom_domains:basic"
+      sh cmd
+    end
+
+    desc "Push to Heroku"
+    task :push do
+      cmd = Dir.pwd =~ /heroku$/ ? "" : "cd heroku && "
+      cmd += "git push heroku master"
+      sh cmd
+    end
+
+    desc "Build, configure and push a shortener app to Heroku"
+    task :setup => [:build, :config, :push] do
+      puts "\nYour app has (hopefully) been created and pushed and available @" +
+        " http://#{$name}.heroku.com\n\n" +
+        "the Custom Domain Addon has been added, but still needs configuring, for" +
+        " steps see\n http://devcenter.heroku.com/articles/custom-domains"
+    end # => setup
+
+  end # => heroku
+
+  namespace :data do 
+
+    desc "replace hyphenated keys with sanitized ones."
+    task :dehyphenate_keys do
+      require 'shortener'
+      redis = Shortener::Configuration.new.redis
+      redis.keys("data:*").each do |k|
+        hsh = redis.hgetall(k)
+        puts "checking #{hsh}" if ENV['VERBOSE']
+        set_count, click_count = hsh['set-count'], hsh['click_count']
+        arr = Array.new
+        arr.concat([:set_count, set_count]) unless set_count.nil?
+        arr.concat([:click_count, click_count]) unless click_count.nil?
+        puts "** setting: #{arr.inspect}" if ENV['VERBOSE']
+        unless arr.empty?
+          redis.hmset(k, *arr)
+          redis.hdel(k, 'set-count')
+          redis.hdel(k, 'click-count')
+        end
+        puts "#{k} afterwards: #{redis.hgetall(k)}" if ENV['VERBOSE']
+      end
+    end
+
+  end # => data
+
+end # => short

data/lib/shortener/version.rb

@@ -1,6 +1,6 @@
 
 class Shortener
 
-  VERSION = '0.4.3'
+  VERSION = '0.5.0'
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: short
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-20 00:00:00.000000000 Z
+date: 2012-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &70312062943700 !ruby/object:Gem::Requirement
+  requirement: &70210385354960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70312062943700
+  version_requirements: *70210385354960
 - !ruby/object:Gem::Dependency
   name: redis-namespace
-  requirement: &70312062941140 !ruby/object:Gem::Requirement
+  requirement: &70210385354320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70312062941140
+  version_requirements: *70210385354320
 - !ruby/object:Gem::Dependency
   name: haml
-  requirement: &70312062940700 !ruby/object:Gem::Requirement
+  requirement: &70210385353860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70312062940700
+  version_requirements: *70210385353860
 - !ruby/object:Gem::Dependency
   name: turn
-  requirement: &70312062940220 !ruby/object:Gem::Requirement
+  requirement: &70210385351560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70312062940220
+  version_requirements: *70210385351560
 description: A (hopefully) easy and handy deployable APIable way to shorten links.
 email:
 - jake@jakewilkins.com
@@ -101,9 +101,9 @@ files:
 - lib/shortener/server/views/s3/video.haml
 - lib/shortener/server/views/upload.haml
 - lib/shortener/short.rb
+- lib/shortener/tasks/heroku.rake
 - lib/shortener/version.rb
 - short.gemspec
-- tasks/heroku.rake
 - test/test_configuration.rb
 - test/test_server.rb
 - test/test_short.rb

data/tasks/heroku.rake

@@ -1,47 +0,0 @@
-$gem_dir = File.expand_path(File.dirname(File.dirname(__FILE__)))
-def gem_file(*args)
-  ret = args.map {|f| File.join($gem_dir, f)}.join(" ")
-end
-namespace :heroku do
-
-  desc "Build a Heroku Ready Git repo"
-  task :build do
-    cmd = ""#mkdir heroku"
-    cmd += "mkdir heroku/server"
-    cmd += " && cp -r #{gem_file("lib/shortener/server/*")} ./heroku/server/"
-    cmd += " && cp #{gem_file('lib/shortener/server.rb')} ./heroku/main.rb"
-    cmd += " && cp #{gem_file('lib/shortener/configuration.rb')} ./heroku/configuration.rb"
-    cmd += " && mv ./heroku/server/config.ru.template ./heroku/config.ru"
-    cmd += " && mv ./heroku/server/Gemfile ./heroku/server/Gemfile.lock ./heroku"
-    cmd += " && git init heroku && cd heroku && git add . && git commit -m initial"
-    sh cmd
-  end
-
-  desc "config a Heroku app the way we need it. Optionally set APPNAME to set heroku app name"
-  task :config do
-    require_relative '../lib/shortener'
-    $name = ENV['APPNAME'] || "shner-#{`whoami`.chomp}"
-    cmd = Dir.pwd =~ /heroku$/ ? "" : "cd heroku && "
-    cmd += "heroku create #{$name}"
-    cmd += " && heroku addons:add redistogo:nano"
-    cmd += " && heroku config:add #{Shortener::Configuration.new.to_params}"
-    cmd += " && heroku addons:add custom_domains:basic"
-    sh cmd
-  end
-
-  desc "Push to Heroku"
-  task :push do
-    cmd = Dir.pwd =~ /heroku$/ ? "" : "cd heroku && "
-    cmd += "git push heroku master"
-    sh cmd
-  end
-
-  desc "Build, configure and push a shortener app to Heroku"
-  task :setup => [:build, :config, :push] do
-    puts "\nYour app has (hopefully) been created and pushed and available @" +
-      " http://#{$name}.heroku.com\n\n" +
-      "the Custom Domain Addon has been added, but still needs configuring, for" +
-      " steps see\n http://devcenter.heroku.com/articles/custom-domains"
-  end
-
-end