quick_response 0.2.1 → 0.2.2

data/README.md

@@ -0,0 +1,63 @@
+# QuickResponse
+
+QuickResponse is a **QR Code Generator**. It doesn't rely on any image manipulation library. Instead it's thin wrapper around the **Google Chart API**.
+
+## Installation
+
+    gem install quick_response
+    
+## Usage
+
+### Initialization 
+
+First you need to create a QuickResponse object. For example to create a simple textual QR code:
+
+    QuickResponse::Text.new("Hello World!")
+
+…or for a url:
+
+    QuickResponse::Url.new("robinclart.com")
+
+You can also specify a size option:
+
+    QuickResponse::Url.new("robinclart.com", :size => 512)
+
+### Shorthand
+
+You can also use one of the shorthand versions:
+
+    QuickResponse.new(:text, "Hello World!")
+
+…or:
+
+    QuickResponse.text("Hello World!")
+
+### Methods
+
+Once you have your QR object you have two methods available:
+
+  * The first one is `image_url`. This method will return the image url as you can guess.
+  * The second one is `save`. This method takes one argument that must be a string representing the local path where to save the image.
+  
+Examples:
+
+    qr = QuickResponse.url("robinclart.com")
+    
+    qr.image_url
+    => "http://chart.apis.google.com/chart?cht=qr&chs=256x256&chl=http%3A%2F%2Frobinclart.com"
+    
+    qr.save("/tmp/qr/robinclart_com.png")
+
+### Types
+
+Available types are:
+
+  * Text (Takes many arguments that will be joined by a space)
+  * Url (Takes an url as first argument)
+  * Email (The first argument is a mail address)
+  * Call (The first argument is a phone number)
+  * Sms (The first argument is a phone number, the second (optional) is the message)
+  * Geo (Takes two arguments `longitude` and `lattitude`)
+  * Maps (Take an address as first argument and return a link to Google Maps)
+
+

data/lib/quick_response/base.rb

@@ -22,7 +22,7 @@ module QuickResponse
       uri.to_s
     end
 
-    def save(location = "./qr.png")
+    def save(location)
       Net::HTTP.start(uri.host) do |http|
         resp = http.get(image_url)
         open(location, 'wb') do |file|

data/lib/quick_response/types/call.rb

@@ -1,5 +1,5 @@
 module QuickResponse
   class Call < ::QuickResponse::Base
-    format "tel:(.*)"
+    format "tel:(.*)", :limit => 1
   end
 end

data/lib/quick_response/types/email.rb

@@ -1,5 +1,5 @@
 module QuickResponse
   class Email < ::QuickResponse::Base
-    format "mailto:(.*)"
+    format "mailto:(.*)", :limit => 1
   end
 end

data/lib/quick_response/types/maps.rb

@@ -1,6 +1,6 @@
 module QuickResponse
   class Maps < ::QuickResponse::Base
-    format "http://maps.google.com/maps?q=(.*)"
+    format "http://maps.google.com/maps?q=(.*)", :limit => 1
 
     def initialize(*args)
       args = args.map { |a| CGI.escape(a) }

data/lib/quick_response/types/text.rb

@@ -1,5 +1,5 @@
 module QuickResponse
   class Text < ::QuickResponse::Base
-    format "(.*)"
+    format "(.*)", :join => " "
   end
 end

data/lib/quick_response/version.rb

@@ -1,3 +1,3 @@
 module QuickResponse
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 1
-  version: 0.2.1
+  - 2
+  version: 0.2.2
 platform: ruby
 authors: 
 - Robin Clart
@@ -46,6 +46,7 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - Gemfile
+- README.md
 - Rakefile
 - lib/quick_response.rb
 - lib/quick_response/base.rb