bcms_bitly 0.0.2 → 0.0.4

data/README.rdoc

@@ -1,3 +1,51 @@
-= BcmsBitly
+# BcmsBitly
 
-This project rocks and uses MIT-LICENSE.
+This gem will automatically create a Bitly short link when a new page is created.
+
+## Installation
+
+Add this to your Gemfile:
+
+```
+gem 'bcms_bitly'
+```
+
+and then run:
+
+
+```
+bundle install
+rails g cms:install bcms_bitly
+rake db:migrate
+```
+
+This will create an initializer file at `config/initializers/bcms_bitly.rb`. You will need to change the username and api key values to your Bitly credentials:
+
+```
+module BcmsBitly
+  class Engine < ::Rails::Engine
+    config.bitly_username = 'username'
+    config.bitly_api_key  = 'api_key'
+  end
+end
+```
+
+## Usage
+
+After creating a new page, the shortened link will be available through the `short_link` association:
+
+```
+@page.short_link.url
+```
+
+## License
+
+(The MIT License)
+
+Copyright © 2012 Josiah Ivey
+
+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/app/models/bcms_bitly/short_link.rb

@@ -17,7 +17,9 @@ module BcmsBitly
     # Returns the shortened URL String
     def shorten(url)
       Bitly.use_api_version_3
-      bitly = Bitly.new(ENV['nbcf_bitly_username'], ENV['nbcf_bitly_api_key'])
+      username = BcmsBitly::Engine.config.bitly_username
+      api_key  = BcmsBitly::Engine.config.bitly_api_key
+      bitly    = Bitly.new(username, api_key)
       bitly.shorten(url).short_url
     end
   end

data/config/routes.rb

@@ -1,4 +1,6 @@
 BcmsBitly::Engine.routes.draw do
+  mount BcmsBitly::Engine => '/bcms_bitly'
+
   content_blocks :short_links
 
 end

data/lib/bcms_bitly/version.rb

@@ -1,3 +1,3 @@
 module BcmsBitly
-  VERSION = "0.0.2"
+  VERSION = "0.0.4"
 end

data/lib/generators/bcms_bitly/install/install_generator.rb

@@ -2,8 +2,8 @@ require 'cms/module_installation'
 
 class BcmsBitly::InstallGenerator < Cms::ModuleInstallation
   add_migrations_directory_to_source_root __FILE__
-  
-  
+
+
   def copy_migrations
     rake 'bcms_bitly:install:migrations'
   end
@@ -13,9 +13,14 @@ class BcmsBitly::InstallGenerator < Cms::ModuleInstallation
   #  copy_file "../bcms_bitly.seeds.rb", "db/bcms_bitly.seeds.rb"
   #  append_to_file "db/seeds.rb", "load File.expand_path('../bcms_bitly.seeds.rb', __FILE__)\n"
   #end
-  
+
+  def copy_intializer
+    source_path = File.expand_path('../templates/config/initializers/bcms_bitly.rb', __FILE__)
+    copy_file source_path, 'config/initializers/bcms_bitly.rb'
+  end
+
   def add_routes
     mount_engine(BcmsBitly)
   end
-    
+
 end

data/lib/generators/bcms_bitly/install/templates/config/initializers/bcms_bitly.rb

@@ -0,0 +1,6 @@
+module BcmsBitly
+  class Engine < ::Rails::Engine
+    config.bitly_username = 'username'
+    config.bitly_api_key  = 'api_key'
+  end
+end

data/test/dummy/config/initializers/bcms_bitly.rb

@@ -0,0 +1,6 @@
+module BcmsBitly
+  class Engine < ::Rails::Engine
+    config.bitly_username = 'nbcfbitly'
+    config.bitly_api_key  = 'R_10dbfd608150770823d21b1d4d4bde93'
+  end
+end