bitmarkable 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e890b5dc86f7c126f4a0863628edcfca8010f4c7
-  data.tar.gz: b272a1d79dfb9eaad955aa4e4e78e831f8164f6e
+  metadata.gz: b7554826b5ebf3ec1a0c55ca167e8d2915067af5
+  data.tar.gz: c2f68980e91187e5a8831f12b33ac8bfcace9160
 SHA512:
-  metadata.gz: 1fa176d0a208d11b544fb3604217d3a96e6ac4a32f29112b05df390ec955b675fbccbd745f258722597ffede5dae42058d5dd8b3499cdb8eb246b27d68b34030
-  data.tar.gz: 49101feec70242ae29d80c17f8d49f83486edd0a2dec4b8b00cd721e3ce16c461b356d729ce8f6cd39ca15ac2364bbd861cca486f0098841efb5424136a876b5
+  metadata.gz: 1d027139bf4c3704e0810d6533c64fa65a91a70aec68143ae540ee6fa64602edf81b69fc5c99cb531d2806f4be31926796822e7614c781ce0c20395446c352a6
+  data.tar.gz: 8c405a09f2ebc4a1cf31f33ded440bce72080a5c6fdcf45c30cb58394094666a126b2455ff4b184db7e5928b4043517b25aa923f907691295762533e368aa091

data/README.md

@@ -1,6 +1,6 @@
 # Bitmarkable
 
-TODO: Write a gem description
+Generate and persist a bitly URL to an ActiveRecord object using Redis.
 
 ## Installation
 
@@ -18,7 +18,24 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+Bitmarkable.configure do |c|
+  c.login = "username" # bitly username
+  c.api_key = "12345" # https://bitly.com/a/your_api_key
+  c.base_url = Rails.application.config.base_url # base URL to prepend, if you're using relative paths
+end
+```
+
+Then, include it in your model.
+
+```ruby
+include Bitmarkable::Bitmark
+bitmark :site_url # optional method/attribute containing the URL to shorten, defaults to :url
+```
+
+The short URL can then be fetched using `instance.bitmark`. The value is stored in Redis with the key `class_name:id:bitmark`.
+
+If the bitmarkable class responds to `.delay` (e.g. you're using DelayedJob or Sidekiq) then bitmarks will be processed asynchronously.
 
 ## Contributing
 

data/lib/bitmarkable/bitmark.rb

@@ -9,13 +9,28 @@ module Bitmarkable
       cattr_accessor :url_field
       after_save :generate_bitmark
 
-      def self.bitmark(url_field = nil)
-        base_class.url_field = url_field || 'url'
-      end
+      bitmark self.url_field || 'url'
 
       def generate_bitmark
-        self.bitmark = Bitly.shorten(Bitmarkable.configuration.base_url + self.send(url_field.to_sym))
+        if self.class.respond_to? :delay
+          self.class.delay.save_bitmark(self, "#{Bitmarkable.config.base_url}#{self.send(url_field.to_sym)}")
+        else
+          self.class.save_bitmark(self, "#{Bitmarkable.config.base_url}#{self.send(url_field.to_sym)}")
+        end
+      end
+    end
+
+    module ClassMethods
+      def bitmark(url_field = nil)
+        self.url_field = url_field
+      end
+
+      def save_bitmark(object, url)
+        object.bitmark = Bitly.shorten(url)
       end
     end
+
+    extend ClassMethods
+
   end
 end

data/lib/bitmarkable/{configuration.rb → config.rb}

@@ -12,6 +12,6 @@ module Bitmarkable
   end
 
   def self.configure
-    yield(configuration) if block_given?
+    yield(config) if block_given?
   end
 end

data/lib/bitmarkable.rb

@@ -2,10 +2,10 @@ require "active_support"
 require "active_record"
 require "httparty"
 require "redis-objects"
-require "bitmarkable/configuration"
+require "bitmarkable/config"
 require "bitmarkable/bitmark"
 require "bitmarkable/bitly"
 
 module Bitmarkable
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bitmarkable
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Paul Friedman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-08 00:00:00.000000000 Z
+date: 2013-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -111,7 +111,7 @@ files:
 - lib/bitmarkable.rb
 - lib/bitmarkable/bitly.rb
 - lib/bitmarkable/bitmark.rb
-- lib/bitmarkable/configuration.rb
+- lib/bitmarkable/config.rb
 homepage: ''
 licenses:
 - MIT