stw_engine 0.0.2 → 0.0.3

data/README.markdown

@@ -0,0 +1,75 @@
+# stw_engine gem
+
+## What is it?
+A Ruby gem wrapping the shrinktheweb.com API.
+
+## Who should use it?
+Any Ruby on Rails developer who wants/needs to generate screenshots from sites using shrinktheweb.com.
+
+
+## Installation
+
+	gem install nokogiri
+	
+    gem install stw_gem
+    
+    
+
+
+### Configuration
+
+You must define your Access key or secret key, they are required:
+
+ StwEngine.config({
+
+    # required
+    :api_key      => 'xXXXXXXXXXXXXX',
+    :private_key  => 'xxxx,
+
+    #optional use if supported
+    :size  => 'lg',
+
+
+})
+
+
+
+##### size
+The following sizes are available depending on the account level
+
+
+* v6 (default)
+* v4
+* v3
+
+
+
+
+##### mode
+
+
+## Usage
+
+
+Generate an image tag:
+
+    stw_show url
+
+Generate an image tag with size option:
+
+	stw_show url, :size => 'xlg'
+    
+
+
+To only get the image url:
+
+    stw_show_url url, [options]
+    
+
+
+
+
+
+
+
+

data/lib/stw_engine/config.rb

@@ -12,9 +12,8 @@ module StwEngine
     self.api_secret = c[:api_secret]
 
     # optional
-    self.mode = c[:mode] if c[:mode]
-    self.api_version = c[:api_version] if c[:api_version]
-    self.api_url = c[:api_url] if c[:api_url]
+    self.size = c[:size] if c[:size]
+    
   end
 
   def api_key=api_key
@@ -34,6 +33,14 @@ module StwEngine
     raise 'StwEngine error: No api secret defined!' if @api_secret.nil?
     @api_secret
   end
+  
+  def size=size
+    @size = size
+  end
+
+  def size    
+    @size
+  end
 
   def mode=mode
     raise "StwEngine error: Invalid mode, only #{ MODES.join(', ') } are allowed" unless MODES.include?(mode.to_s)

data/lib/stw_engine/helpers/common.rb

@@ -51,14 +51,14 @@ module StwEngine
 		
 	end
 
-    # function to store the image and return the image url
-	def stw_show url, options ={}
-		sizes = ['xlg', 'lg', 'sm', 'vsm', 'tny', 'mcr']
-		params = {:stwaccesskeyid => StwEngine.api_key , 
-		:stwu => StwEngine.api_secret}
-		
-		if options.key?(:size)
-			case options[:size]
+	#function to return only url 
+	
+	def stw_show_url url, options={}
+		stw_show url, options, only_url=true
+	end
+	
+	def add_size size, params
+			case size
 				when 'xlg'
 					params['stwxmax'] = 320
 				when 'lg'
@@ -73,7 +73,24 @@ module StwEngine
 					params['stwxmax'] = 75
 		
 			end
+		return params
+	end
+	
+    # function to store the image and return the image url
+	def stw_show url, options ={}, only_url=false
+		sizes = ['xlg', 'lg', 'sm', 'vsm', 'tny', 'mcr']
+		params = {:stwaccesskeyid => StwEngine.api_key , 
+		:stwu => StwEngine.api_secret}
+		
+		if StwEngine.size
+			params = add_size StwEngine.size, params
 		end
+		
+		if options.key?(:size)
+			params = add_size options[:size], params
+
+		end
+		#return params
 		params[:stwurl] = url 
 		
 		
@@ -129,6 +146,11 @@ module StwEngine
 		open(path, 'wb') do |file|
 			file << open(image).read
 		end
+		img_path = "/stw/#{filename}"
+		
+		if only_url
+			return img_path
+		end
 		
 		img = "<img src=\"/stw/#{filename}\"/>"
 		img.respond_to?(:html_safe) ? img.html_safe : img 

data/lib/stw_engine/version.rb

@@ -1,3 +1,3 @@
 module StwEngine
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stw_engine
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-10 00:00:00.000000000 Z
+date: 2013-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &83508830 !ruby/object:Gem::Requirement
+  requirement: &83705640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *83508830
+  version_requirements: *83705640
 description: Show thumbnail from shrinktheweb
 email:
 - sabirmostofa@gmail.com
@@ -33,6 +33,7 @@ files:
 - Gemfile
 - Gemfile.lock
 - MIT-LICENSE
+- README.markdown
 - README.rdoc
 - Rakefile
 - app/assets/images/stw_engine/.gitkeep
@@ -70,6 +71,7 @@ files:
 - lib/tasks/stw_engine_tasks.rake
 - script/rails
 - stw_engine-0.0.1.gem
+- stw_engine-0.0.2.gem
 - stw_engine.gemspec
 - test/dummy/README.rdoc
 - test/dummy/Rakefile