plezi 0.12.1 → 0.12.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bb98dd3b32e4204480007a592bdd9e7d7b55fa08
-  data.tar.gz: b5b670f66538b2a98d7306176528ddfd45e6a878
+  metadata.gz: 57622e2bc4d95fe0c0902460b9d181632276064f
+  data.tar.gz: 2c5b4ea394f9984cd72c7707a423099402a323de
 SHA512:
-  metadata.gz: 78e46c96f20cc3955000f0cb32a2ebf7c5cd1d472176bdba6990b3f4f840271a6cb3426bd0774eb96d9493e90e44ad22c68164ce4fa7bf2a4be4ef869ef12fe0
-  data.tar.gz: 90fe75d999ab81c05ea98249907c368858eaf0c4bab5145630e23428cf3549a5c96eef0fc78abb53ae7b3341ddd34818723da8fd4b20fd28803da005bf25d5f6
+  metadata.gz: 54bfd6e45045a268a2980618e220976bfc92a8d1ad31312e1a1f9ebc276ecb6ad0e7f442841076ef8a554fc501e525647c39666ab360c02fb4bc67ddd648078e
+  data.tar.gz: bc7f627f2f9b9f068d72e22a4535ee4dafef8eec4363d49b39b53c4742a0b3fa0b3bb2dbd176ff463b39b3edbab7e3bd7b913e7905eed7ec6b8c989a112942ae

data/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 ***
 
+Change log v.0.12.2
+
+**Update**: Plezi now leverages Iodine's support for a File response body, allowing for a smaller memory footpring when sending large files.
+
+**Fix**: fixed an issue where host aliases wouldn't initiate, causing host initiation to fail, due to a typo in the HTTPRouter.
+
+**Fix**: fixed an issue with the plezi OAuth2 extention, which caused OAuth to fail when encoding URL data before initiating the OAuth process. OAuth2 should now work as expected. Plezi's OAuth2 has built-in support for both Google and Facebook authentication, as well as an API that allows implemnting more OAuth2 complient services (i.e. GitHub).
+
+***
+
 Change log v.0.12.1
 
 **Fix**: fixed an issue with the app template, where a typo (an extra comma sign ',') caused the `host` command to fail.

data/lib/plezi/handlers/controller_magic.rb

@@ -83,7 +83,7 @@ module Plezi
 				url = "#{request.base_url}/#{url.to_s.gsub('_', '/')}" if url.is_a?(Symbol) || ( url.is_a?(String) && url.empty? ) || url.nil?
 				# redirect
 				response.status = options.delete(:status) || 302
-				response['Location'] = url
+				response['location'] = url
 				response['content-length'] ||= 0
 				flash.update options
 				true
@@ -119,7 +119,7 @@ module Plezi
 			# this is also usful for offering a file name for the browser to "save as".
 			#
 			# it accepts:
-			# data:: the data to be sent
+			# data:: the data to be sent - this could be a String or an open File handle.
 			# options:: a hash of any of the options listed furtheron.
 			#
 			# the :symbol=>value options are:
@@ -129,15 +129,17 @@ module Plezi
 			#
 			def send_data data, options = {}
 				raise 'Cannot use "send_data" after headers were sent' if response.headers_sent?
-				Plezi.warn 'HTTP response buffer is cleared by `#send_data`' if response.body && response.body.any? && response.body.clear
-				response << data
+				if response.body && response.body.any?
+					Plezi.warn 'existing response body was cleared by `#send_data`!'
+					response.body.close if response.body.respond_to? :close
+				end
+				response = data
 
 				# set headers
 				content_disposition = options[:inline] ? 'inline' : 'attachment'
-				content_disposition << "; filename=#{options[:filename]}" if options[:filename]
+				content_disposition << "; filename=#{::File.basename(options[:filename])}" if options[:filename]
 
 				response['content-type'] = (options[:type] ||= MimeTypeHelper::MIME_DICTIONARY[::File.extname(options[:filename])])
-				response['content-length'] = data.bytesize rescue true
 				response['content-disposition'] = content_disposition
 				true
 			end

data/lib/plezi/handlers/http_router.rb

@@ -47,13 +47,13 @@ module Plezi
 				params[:public] ||= params[:root] # backwards compatability
 				host_name = (host_name.is_a?(String) ? host_name.to_s.downcase : (host_name.is_a?(Regexp) ? host_name : :default))
 				@active_host = get_host(host_name) || ( @hosts[host_name] = Host.new(params) )
-				add_alias host_name, *params[:alias] if params[:alias]
+				add_alias host_name, *params[:alias] if params[:alias] # && host_name != :default
 				@active_host
 			end
 			# adds an alias to an existing host name (normally through the :alias parameter in the `add_host` method).
 			def add_alias host_name, *aliases
 				host = get_host host_name
-				raise "Couldn't find requested host to add alias." unless host.
+				raise "Couldn't find requested host to add alias." unless host
 				aliases.each {|a| @hosts[a.to_s.downcase] = host}
 				true
 			end
@@ -120,7 +120,11 @@ module Plezi
 
 				# send the file if it exists (no render needed)
 				if File.exists?(source_file)
-					data = Plezi.cache_needs_update?(source_file) ? Plezi.save_file(target_file, Plezi.reload_file(source_file), (params[:public] && params[:save_assets])) : Plezi.load_file(source_file)
+					data = if ::Plezi::Cache::CACHABLE.include?(::File.extname(source_file)[1..-1])
+						Plezi.cache_needs_update?(source_file) ? Plezi.save_file(target_file, Plezi.reload_file(source_file), (params[:public] && params[:save_assets])) : Plezi.load_file(source_file)
+					else
+						::File.new source_file, 'rb'
+					end
 					return (data ? Base::HTTPSender.send_raw_data(request, response, data, MimeTypeHelper::MIME_DICTIONARY[::File.extname(source_file)]) : false)
 				end
 

data/lib/plezi/helpers/http_sender.rb

@@ -49,7 +49,12 @@ module Plezi
 			# sends a file/cacheed data if it exists. otherwise returns false.
 			def send_file request, response, filename, status_code = 200, headers = {}
 				if Plezi.file_exists?(filename) && !::File.directory?(filename)
-					return send_raw_data request, response, Plezi.load_file(filename), MimeTypeHelper::MIME_DICTIONARY[::File.extname(filename)], status_code, headers
+					data = if Plezi::Cache::CACHABLE.include?(::File.extname(filename)[1..-1])
+						Plezi.load_file(filename)
+					else
+						::File.new filename, 'rb'
+					end
+					return send_raw_data request, response, data , MimeTypeHelper::MIME_DICTIONARY[::File.extname(filename)], status_code, headers
 				end
 				return false
 			end
@@ -59,8 +64,8 @@ module Plezi
 				response.status = status_code
 				response['content-type'] = mime
 				response['cache-control'] ||= 'public, max-age=86400'					
-				response << data
-				response['content-length'] = data.bytesize
+				response.body = data
+				# response['content-length'] = data.bytesize #this one is automated by the server and should be avoided to support Range requests.
 				true
 			end##########
 

data/lib/plezi/oauth/auth_controller.rb

@@ -88,8 +88,8 @@ module Plezi
 		# options:: a Hash of options, some of which are required.
 		#
 		# The options are:
-		# app_id:: Required. The aplication's unique ID registered with the service. i.e. ENV [FB_APP_ID] (storing these in environment variables is safer then hardcoding them)
-		# app_secret:: Required. The aplication's unique secret registered with the service.
+		# app_id:: Required. The aplication's unique ID (sometimes called `client_id`) registered with the service. i.e. ENV [FB_APP_ID] (storing these in environment variables is safer then hardcoding them)
+		# app_secret:: Required. The aplication's unique secret registered with the service (sometimes called `client_secret`).
 		# auth_url:: Required. The authentication URL. This is the url to which the user is redirected. i.e.: "https://www.facebook.com/dialog/oauth"
 		# token_url:: Required. The token request URL. This is the url used to switch the single-use code into a persistant authentication token. i.e.: "https://www.googleapis.com/oauth2/v3/token"
 		# profile_url:: Required. The URL used to ask the service for the user's profile (the service's API url). i.e.: "https://graph.facebook.com/v2.3/me"
@@ -110,7 +110,7 @@ module Plezi
 		# * google token_url: "https://www.googleapis.com/oauth2/v3/token"
 		# * google profile_url: "https://www.googleapis.com/plus/v1/people/me"
 		#
-		# to change the default url's for Facebook or Google, simpley re-register the service using this method.
+		# to change the default scope or url's for Facebook or Google, simpley re-register the service using this method.
 		#
 		def self.register_service service_name, options
 			raise "Cannot register service, missing required information." unless service_name && options[:auth_url] && options[:token_url] && options[:profile_url] && options[:app_id] && options[:app_secret]
@@ -190,7 +190,7 @@ module Plezi
 		def _auth_url_for service_name
 			service = SERVICES[service_name]
 			return nil unless service
-			redirect_uri = Plezi::Base::Helpers.encode_url "#{request.base_url}/auth/#{service_name.to_s}", :url #response_type
+			redirect_uri = Plezi::Base::Helpers.encode_url "#{request.base_url}/auth/#{service_name.to_s}" #response_type
 			return "#{service[:auth_url]}?client_id=#{service[:app_id]}&redirect_uri=#{redirect_uri}&scope=#{service[:scope]}&response_type=code"
 		end
 

data/lib/plezi/version.rb

@@ -1,3 +1,3 @@
 module Plezi
-    VERSION = "0.12.1"
+    VERSION = "0.12.2"
 end

data/plezi.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "iodine", "~> 0.1.2"
+  spec.add_dependency "iodine", "~> 0.1.5"
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
 

data/resources/controller.rb

@@ -29,7 +29,7 @@
 # flash:: a hash used for one-time cookies (get and set). any added values will be available for the same client for this and the next connection, after which they are removed.
 #
 # redirect_to:: easily set up redirection.
-# send_data:: easily send data, setting the content-type and content-length headers.
+# send_data:: easily send data, setting the content-type header.
 # render:: easily render Slim, Haml and IRB files into String text.
 #
 class SampleController

data/resources/mini_app.rb

@@ -73,8 +73,8 @@ host host: :default,
 	# route "/:locale{#{I18n.available_locales.join "|"}}/*" , false if defined? I18n
 	#
 	# # OAuth2 - Facebook / Google authentication
-	# require 'plezi/oauth'
 	# ENV["FB_APP_ID"] ||= "app id"; ENV["FB_APP_SECRET"] ||= "secret"; ENV['GOOGLE_APP_ID'] = "app id"; ENV['GOOGLE_APP_SECRET'] = "secret"
+	# require 'plezi/oauth' # do this AFTER setting ENV variables.
 	# create_auth_shared_route do |service_name, auth_token, remote_user_id, remote_user_email, remote_response|
 	#         # ...callback for authentication.
 	#         # This callback should return the app user object or false

data/resources/websockets.js

@@ -10,7 +10,8 @@ var websocket = NaN
 var websocket_fail_count = 0
 // to limit failed reconnection attempts, set this to a number.
 var websocket_fail_limit = NaN
-
+// to offer some space between reconnection attempts, set this interval in miliseconds.
+var websocket_reconnect_interval = 250
 
 function init_websocket()
 {
@@ -33,12 +34,12 @@ function init_websocket()
 			// update the count
 			websocket_fail_count += 1;
 			// try to reconect
-			init_websocket();
+			setTimeout( init_websocket, websocket_reconnect_interval);
 		};
 	};
 	websocket.onerror = function(e) {
 		// update the count.
-		websocket_fail_limit += 1
+		websocket_fail_count += 1
 		// what do you want to do now?
 	};
 	websocket.onmessage = function(e) {

data/websocket chatroom.md

@@ -67,11 +67,13 @@ require 'pathname'
 Root = Pathname.new(File.dirname(__FILE__)).expand_path
 ```
 
-Then, we set up the Plezi service's parameters - parameters which Plezi will use to create our main service and host.
+Then, we set up Plezi's Http Host parameters.
 
-A service, in this case, is realy just a nice word for the Plezi server (which might have a number of services or hosts). We will have only one service and one host, so it's very easy to set up.
+A host, in this case, refers to the domain name that the request belongs to. The default domain name is a catch-all (answers requests with any domain name). Setting up hosts is a great way to manage sub-domains (i.e. serving two different home pages for `www.example.com` and `admin.example.com`).
 
-As you can see, some options are there for later, but are disabled for now.
+We will have only one one host for this application, so it's very easy to set up.
+
+As you can see, some options are there for later, but are disabled for now. here are some of the common options:
 
 - **public**: this option defines the folder from which Plezi should serve public static files (html files, images etc'). We will not be serving any static files at the moment, so this option is disabled.
 
@@ -81,17 +83,14 @@ As you can see, some options are there for later, but are disabled for now.
 
 - **_templates_**: this option tells Plezi where to look for template files (.haml / .erb files). Since we will use a template file for our HTML, let's go ahead and create a subfolder called `views` and set that as our templates source folder.
 
-- **ssl**: this option, if set to true, will make our service into an SSL/TSL encrypted service (as well as our websocket service)... we can leave this off for now - it's actually hardly ever used since it's usually better to leave that to our production server.
-
-- **port**: Hardcoding a port would override the default port (which is either 3000 or the default port specified using the `-p <port>`). For this demo, as in most cases, it's best to a avoid setting up a port and preffer the default preferance.
+- **host**: a host name, if we need one (can also be a Regexp object).
 
 ```ruby
-service_options = {
+host_options = {
 	# public: Root.join('public').to_s,
 	# assets: Root.join('assets').to_s,
 	# assets_public: '/assets',
-	templates: Root.join('views').to_s,
-	ssl: false
+	templates: Root.join('views').to_s
 }
 ```
 
@@ -100,7 +99,7 @@ Next we call the `host` command - this command sets up some of the host options
 The port plezi uses by default is either 3000 [http://localhost:3000/](http://localhost:3000/) or the port defined when calling the script (i.e. `./mychat.rb -p 8080`).
 
 ```ruby
-host :default, service_options
+host host_options
 ```
 
 Last, but not least, we tell Plezi to connect the root of our web application to our ChatController - in other words, make sure the root _path_ ('/') is connected to the ChatController class.
@@ -476,15 +475,14 @@ require 'pathname'
 Root = Pathname.new(File.dirname(__FILE__)).expand_path
 
 # set up the Plezi service options
-service_options = {
+host_options = {
 	# root: Root.join('public').to_s,
 	# assets: Root.join('assets').to_s,
 	# assets_public: '/',
-	templates: Root.join('views').to_s,
-	ssl: false
+	templates: Root.join('views').to_s
 }
 
-host :default, service_options
+host host_options
 
 # this routes the root of the application ('/') to our ChatController
 route '/:id', ChatController

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plezi
 version: !ruby/object:Gem::Version
-  version: 0.12.1
+  version: 0.12.2
 platform: ruby
 authors:
 - Boaz Segev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-25 00:00:00.000000000 Z
+date: 2015-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: iodine
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.2
+        version: 0.1.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.2
+        version: 0.1.5
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement