firefly 1.3.1 → 1.4.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    firefly (1.3.0)
+    firefly (1.3.1)
       dm-aggregates (~> 1.0.2)
       dm-core (~> 1.0.2)
       dm-migrations (~> 1.0.2)

data/HISTORY

@@ -1,3 +1,7 @@
+= 1.4.0 - 2011-02-11
+
+ * 2011-02-21 Added support for 'share to twitter' links [ariejan]
+
 = 1.3.1 / 2011-02-20
 
  * 2011-02-20 Fixed issue with escaped characters in URL (ticket #21) [ariejan]

data/README.md

@@ -40,6 +40,17 @@ After you have installed the Firefly gem you should create a `config.ru` file th
       #
       # Default: Check this out: %short_url%
       # set :tweet,       "I loved this: %short_url% - Go check it out now!"
+
+      # If you want to enable 'share to twitter'
+
+      # A secure key to be used with 'share to twitter'
+      # set :sharing_key,    "set-a-long-secure-key-here"
+
+      # Currently only twitter is supported
+      # set :sharing_targets, [:twitter]
+
+      # Set the TLDs (in URLs) that are allowed to be shortened
+      # set :sharing_domains, ["example.com", "mydomain.com"]
     end
 
     run app
@@ -67,6 +78,13 @@ All configuration is done in `config.ru`.
  * `:database` a database URI that [DataMapper][4] can understand.
  * `:recent_urls` sets the number of URLs to show in the overview. Default: 25.
  * `:tweet` set the template to use for tweets. Default: `"Check this out: %short_url%"`
+ * `:sharing_key` set this to something long and secure, used for
+   creating 'share to twitter' links.
+ * `:sharing_targets` set to `[:twitter]` if you want to enable sharing
+   to twitter
+ * `:sharing_domains` set to an array of TLDs. Only urls shared in those
+   domains will be allowed. Set to an empty array (`[]`) if you want to
+accept all domains.
 
 It's possible to use all kinds of backends with DataMapper. Sqlite3 and MySQL have been tested, but others may work as well. 
 
@@ -76,6 +94,8 @@ Simply visit `http://:hostname/` and enter your `:api_key`. You can now shorten
 
 ## Advanced usage
 
+### Using the API
+
 You may also use the API to automate URL shortening. Here's how.
 
 Adding a URL is done by doing a simple POST request that includes the URL and your API key. 
@@ -99,6 +119,21 @@ After you restart Terminal.app (or at least reload the `.profile` file) you can
     -- http://ariejan.net => http://aj.gs/1
     Short URL copied to clipboard.
 
+### Using the 'Share to Twitter' features
+
+The share to twitter feature allows you to create custom links on your
+site. When clicked, the specified URL will be shortened and the user
+will be redirect to Twitter to share the new short URL.
+
+    GET /api/share
+    POST /api/share
+
+    Parameters:
+      url - Long URL to share (required)
+      key - The sharing key, specified in `config.ru` (required)
+      target - Target to share to, currently only `twitter` is supported (required)
+      title - Title of text to use in the tweet (optional)
+
 # Bugs, Feature Requests, etc. 
 
  * [Source][5]

data/config.ru.example

@@ -17,6 +17,20 @@ app = Firefly::Server.new do
   # Make sure to install the do_mysql gem:
   #    sudo gem install do_mysql
   # set :database,    "mysql://root@localhost/firefly"
+
+  # If you want to enable 'share to twitter'
+
+  # A secure key to be used with 'share to twitter'
+  # set :sharing_key,    "set-a-long-secure-key-here"
+  set :sharing_key,      ""
+
+  # Currently only twitter is supported
+  # set :sharing_targets, [:twitter]
+  set :sharing_targets, []
+
+  # Set the TLDs (in URLs) that are allowed to be shortened
+  # set :sharing_domains, ["example.com", "mydomain.com"]
+  set :sharing_domain, []
 end
 
 run app

data/lib/firefly/server.rb

@@ -43,6 +43,31 @@ module Firefly
         key == Digest::MD5.hexdigest(config[:api_key])
       end
 
+      def has_valid_share_key?
+        return false unless @config.has_key?(:sharing_key)
+        @config[:sharing_key] == params[:key]
+      end
+
+      def has_valid_share_domain?
+        return false unless @config.has_key?(:sharing_domains)
+        return true if @config[:sharing_domains].empty?
+        @config[:sharing_domains].any? { |domain| params[:url].include?(domain) }
+      end
+
+      def has_valid_share_target?
+        return false unless @config.has_key?(:sharing_domains)
+        @config[:sharing_targets].include?(params[:target].downcase.to_sym)
+      end
+
+      def validate_share_permission
+        if has_valid_share_key? && has_valid_share_domain? && has_valid_share_target?
+          return true
+        else
+          status 401
+          return false
+        end
+      end
+
       def validate_api_permission
         if !has_valid_api_cookie? && params[:api_key] != config[:api_key]
           status 401
@@ -79,8 +104,12 @@ module Firefly
       end
 
       # Format a tweet
-      def tweet(url)
-        config[:tweet].gsub('%short_url%', url)
+      def tweet(url, message = nil)
+        if message.nil?
+          config[:tweet].gsub('%short_url%', url)
+        else
+          "#{message} #{url}"
+        end
       end
 
       def store_api_key(key)
@@ -138,6 +167,21 @@ module Firefly
     get '/api/add', &api_add
     post '/api/add', &api_add
 
+    api_share = lambda {
+      validate_share_permission or return "Cannot share that URL."
+
+      @url = params[:url]
+      @code, @result = generate_short_url(@url, nil)
+      invalid = @code.nil?
+
+      if params[:target].downcase.to_sym == :twitter
+        redirect(URI.escape("http://twitter.com/home?status=#{tweet("http://#{config[:hostname]}/#{@code}", params[:title])}"))
+      end
+    }
+
+    get '/api/share', &api_share
+    post '/api/share', &api_share
+
     # GET /b3d+
     #
     # Show info on the URL

data/lib/firefly/version.rb

@@ -1,3 +1,3 @@
 module Firefly
-  VERSION = "1.3.1"
+  VERSION = "1.4.0"
 end

data/spec/firefly/sharing_spec.rb

@@ -0,0 +1,65 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "Sharing" do
+  include Rack::Test::Methods
+
+  def app
+    @@app
+  end
+
+  before(:each) do
+    @params = {
+      :url    => 'http://example.com/test',
+      :key    => 'asdfasdf',
+      :target => 'twitter',
+      :title  => 'Test post'
+    }
+  end
+
+  [:post, :get].each do |verb|
+    describe "twitter" do
+      it "should create a shortened URL" do
+        lambda {
+          self.send verb, '/api/share', @params
+        }.should change(Firefly::Url, :count).by(1)
+      end
+
+      it "should redirect to twitter with status" do
+        self.send verb, '/api/share', @params
+        last_response.should be_redirect
+        last_response['Location'].should match(/twitter.com/i)
+      end
+
+      it "should post the title and short url to twitter" do
+        self.send verb, '/api/share', @params
+        url = Firefly::Url.first(:url => @params[:url])
+
+        last_response['Location'].should include(URI.escape("#{@params[:title]} http://test.host/#{url.code}"))
+      end
+
+      it "should not allow sharing of example.org URL" do
+        self.send verb, '/api/share', @params.merge(:url => 'http://example.org/test123')
+        last_response.status.should eql(401)
+        last_response.body.should match(/cannot share that URL/i)
+      end
+
+      it "should not create a short URL for example.org URL" do
+        lambda {
+          self.send verb, '/api/share', @params.merge(:url => 'http://example.org/test123')
+        }.should_not change(Firefly::Url, :count)
+      end
+
+      it "should not share to facebook" do
+        self.send verb, '/api/share', @params.merge(:target => 'facebook')
+        last_response.status.should eql(401)
+        last_response.body.should match(/cannot share that URL/i)
+      end
+
+      it "should not create a short URL for facebook" do
+        lambda {
+          self.send verb, '/api/share', @params.merge(:target => 'facebook')
+        }.should_not change(Firefly::Url, :count)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -17,9 +17,13 @@ set :raise_errors, true
 set :logging, false
 
 @@app = Firefly::Server.new do
-  set :hostname,    "test.host"
-  set :api_key,     "test"
-  set :database,    "mysql://root@localhost/firefly_test"
+  set :hostname,        "test.host"
+  set :api_key,         "test"
+  set :database,        "mysql://root@localhost/firefly_test"
+
+  set :sharing_key,     "asdfasdf"
+  set :sharing_targets, [:twitter]
+  set :sharing_domains, ["example.com", "example.net"]
 end
 
 Spec::Runner.configure do |config|

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: firefly
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 7
   prerelease: 
   segments: 
   - 1
-  - 3
-  - 1
-  version: 1.3.1
+  - 4
+  - 0
+  version: 1.4.0
 platform: ruby
 authors: 
 - Ariejan de Vroom
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-20 00:00:00 +01:00
+date: 2011-02-21 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -201,6 +201,7 @@ files:
 - spec/firefly/base62_spec.rb
 - spec/firefly/code_factory_spec.rb
 - spec/firefly/server_spec.rb
+- spec/firefly/sharing_spec.rb
 - spec/firefly/url_spec.rb
 - spec/fixtures/urls.yml
 - spec/spec.opts
@@ -251,6 +252,7 @@ test_files:
 - spec/firefly/base62_spec.rb
 - spec/firefly/code_factory_spec.rb
 - spec/firefly/server_spec.rb
+- spec/firefly/sharing_spec.rb
 - spec/firefly/url_spec.rb
 - spec/fixtures/urls.yml
 - spec/spec.opts