faye_service 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 96aeadda779247388258eae123b5e6143b130d58fbe45a2464ad60892758ad1c
-  data.tar.gz: 0ebe43ad01e9575c6174eb171444c530b580c1bc46027b5cd719681223d9b13a
+  metadata.gz: 0b291fd539b70b967dda6fcc5ed3f150be77b80700e2a4f647cdd5e15fbeb9f4
+  data.tar.gz: 943f83644b4478a7a10a64ec690742b1d031e7b9e32bb4091fd2ff1ba99d9ea2
 SHA512:
-  metadata.gz: 1dbd06fd44e4b33beee3805e441243ff49a4fa150da3ad67cdb74b1fdb74c8708fefaddb03384fb891a90925da2d7cee5d4458e8a7e7bea08087fad37a44d20b
-  data.tar.gz: 41ed9bd800e2e8f2f5bb6bac7b25a11b0b4296c9210cd5557a5d5f114fb282d1a160847e0ab91e30764a254b3340a97238434dd561da5b0c5184746f246fc810
+  metadata.gz: fbf8d0d00ff174e1226ebbd2a887bcc03690bb71cc1e1e615c5761ed2bff58f7c71cdbb2b537e666f5b240cbda9a60e04cacba7dc3c26a366b647b1fa4bd478c
+  data.tar.gz: feb70dd29c6b31e4c8d1e55d72f18411d213e32c303fcc50f2f499a8fe3899a22c28a74fea6850a073c07dc3af7a8b906d5eadc87e93a954701262c1441bae29

data/.gitignore

@@ -1 +1,2 @@
 .DS_Store
+*.gem

data/CHANGES

@@ -0,0 +1,2 @@
+1.0.0 Initial Release
+1.0.1 Added logging

data/README.md

@@ -1,14 +1,34 @@
 # Faye Service Gem
 
+[![Gem Version](https://badge.fury.io/rb/faye_service.svg)](https://badge.fury.io/rb/faye_service)
+
 This gem can extend a Ruby project such as Rails, Sinatra, Padrino, Rack, etc. It provides a simple way to communicate with any Faye server instance. 
 
+## To Use This Gem
+
+Add it to your `Gemfile`
+
+```
+gem 'faye_service', '~> 1.0.1'
+```
+
+Or install it locally on your system: 
+
+```
+gem install faye_service
+```
+
 ## Prerequisites
 
 > You need to have at least one instance of Faye running locally on your machine. If you do not have an instance of Faye to connect to, consider using this docker container and this Github repo: 
 
 **Github Repo**: https://github.com/amerlescucodez/faye-docker
 
-**Docker Container**: https://cloud.docker.com/repository/registry-1.docker.io/amerlescucodez/docker-faye-redis
+**Docker Container**: https://hub.docker.com/r/amerlescucodez/docker-faye-ruby
+
+```
+docker pull amerlescucodez/docker-faye-ruby
+```
 
 > You can use this `docker-compose.yaml` template to get the necessary requirements running locally: 
 
@@ -25,16 +45,23 @@ services:
       - primary
 
   faye:
-    image: amerlescucodez/docker-faye-redis:1.0.0
+    image: amerlescucodez/docker-faye-redis:latest
     links:
       - redis
     depends_on:
       - redis
-    restart: always
+    restart: unless-stopped
     ports:
       - 4242:4242
+      - 4443:4443
+    expose:
+      - 4242
+      - 4443
     env_file:
       - .faye.env.development
+    volumes:
+      - ./host/path/to/ssl/certificates:/etc/ssl/certs/faye
+      - ./host/path/to/faye/tokens:/usr/local/faye/tokens
     networks:
       - primary
 
@@ -51,37 +78,29 @@ docker-compose up -d
 
 > And then be able to access https://localhost:4242/faye/client.js
 
-## Installation into Rails
-
-> Open your `Gemfile` and add the following dependency: 
+**Note**: If you're placing Faye inside a docker-compose file that also includes your application, you need to make sure that 
 
-```ruby
-gem "faye_service", "~> 0.0.1", :git => "git@github.com:amerlescucodez/faye-service-gem.git"
-```
+## Installation into Rails
 
-> Create the configuration file: 
+**Important Note**: If you wish to use SSL with Faye, please change all occurences of `http://localhost:4242` to `https://localhost:4443` (or to the specified values in your instance of faye.) Please read this documentation about SSL support: https://github.com/amerlescucodez/faye-docker-ruby#generate-ssl-certificate
 
-Command Line: 
+> Open your `Gemfile` and add the following dependency: 
 
 ```ruby
-touch config/faye_service.yml
+gem "faye_service", "~> 1.0.1"
 ```
 
-Edit `config/faye_service.yml` to: 
-
-```yaml
-faye_service: 
-  url: http://localhost:4242/faye
-  auth_token: YOUR_TOKEN
-  auth_service: YOUR TOKEN
-```
+> Create the faye configuration file:
 
-> Make sure the dependency is being loaded on application boot:
-
-Edit `config/application.rb`:
+Edit `config/initializers/faye.rb`:
 
 ```ruby
 require 'faye_service'
+FayeService.configure do |config|
+  config.url = "http://localhost:4242"
+  config.auth_token = ""
+  config.auth_service = ""
+end
 ```
 
 ## Sending Messages 
@@ -121,19 +140,6 @@ class Sample
 end
 ```
 
-`app/controllers/sample_controller.rb`
-
-```ruby
-class SampleController < ApplicationController
-	def index
-		sample = Sample.new
-		sample.call_with_nothing
-		sample.call_with_user_channel(session[:user_id], params[:message])
-		sample.call_with_big_message
-	end
-end
-```
-
 ## Receiving Messages
 
 ### Include Faye's main JS file
@@ -166,9 +172,14 @@ end
 <script type="text/javascript">
   $(function() {
     var faye = new Faye.Client('http://localhost:4242/faye');
-    faye.subscribe("/my/awesome/channel", function(data) {
+    varsubscription = faye.subscribe("/my/awesome/channel", function(data) {
       alert(data); 
     });
+    subscription.then(function(message){
+      console.log("Successfully subscribed to Faye.");
+    }, function(error){
+      console.log("Error connecting to Faye.");
+    });
   });
 </script>
 ```

data/faye-service.gemspec

@@ -1,13 +1,17 @@
-require File.expand_path('../lib/faye_service/version', __FILE__)
+# require File.expand_path('../lib/faye_service/version', __FILE__)
+$:.push File.expand_path("../lib", __FILE__)
+require "faye_service/version"
 
-Gem::Specification.new do |gem|
-  gem.authors                   = ["Andrei Merlescu"]
-  gem.email                     = ["andrei+github@merlescu.net"]
-  gem.description               = gem.summary = "Simple interface for Faye service messaging."
-  gem.homepage                  = "https://github.com/amerlescucodez/faye-service-gem"
-  gem.license                   = "MIT"
-  gem.files                     = `git ls-files | grep -Ev '^(myapp|examples)'`.split("\n")
-  gem.name                      = "faye_service"
-  gem.require_paths             = ["lib"]
-  gem.version                   = FayeService::VERSION
+
+Gem::Specification.new do |s|
+  s.authors                = ["Andrei Merlescu"]
+  s.email                  = ["andrei+github@merlescu.net"]
+  s.description            = s.summary = "Simple interface for Faye service messaging."
+  s.homepage               = "https://github.com/amerlescucodez/faye-service-gem"
+  s.license                = "MIT"
+  s.files                  = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  s.name                   = "faye_service"
+  s.require_paths          = ["lib"]
+  s.version                = FayeService::VERSION
+  s.add_runtime_dependency 'logging', '~> 2.2', '>= 2.2.2'
 end

data/lib/faye_service.rb

@@ -1,54 +1,19 @@
-require 'net/http'
-require 'faye_service/publisher'
-require 'faye_service/version'
+# frozen_string_literal: true
+require 'logging'
 
 module FayeService
+end
 
-  # Shortuct for current working directory
-  def FayeService.path
-    Dir.pwd
-  end #/def
-
-  # Loads the config/faye_service.yml file and returns its YAML instance
-  #
-  # config/faye_service.yml
-  # =======================
-  # faye_service: 
-  #   url: http://0.0.0.0:8080/faye
-  #   auth_token: APPLICATION_TOKEN
-  #   auth_service: SERVICE_NAME
-  #   return_response: no
-  def FayeService.config
-    # Requires inside the rails/etc application a file called config/faye_service.yml
-    if File.exists?(File.join(path, "config", "faye_service.yml"))
-      config = YAML.load_file(File.join(path, "config","faye_service.yml"))
-      return config
-    else
-      raise(StandardError,"No faye_service.yml file inside the config directory.")
-    end #/if-else
-  end #/def
-
-  # Reads the YAML config file and extracts the faye_service->url definition
-  # => If undefined, raise a Ruby standard error since this gem depends on its definition
-  def FayeService.url
-    FayeService.config["faye_service"]["url"]
-  end #/def
+begin
+	require 'rails'
+rescue LoadError
+	# do nothing
+end #/begin-rescue
 
-  # Reads the YAML config file and extracts the faye_service->auth_token definition
-  # => If undefined, return empty string
-  def FayeService.auth_token
-    FayeService.config["faye_service"]["auth_token"]
-  end #/def
-
-  # Reads the YAML config file and extracts the faye_service->auth_service definition
-  # => If undefined, return empty string
-  def FayeService.auth_service
-    FayeService.config["faye_service"]["auth_service"]
-  end #/def
-
-  # alias of FayeService::Publisher.publish inside lib/faye_service/publisher.rb
-  def FayeService.publish(channel, message)
-    FayeService::Publisher.publish(channel, message)
-  end #/def
+require 'faye_service/config'
+require 'faye_service/logger'
+require 'faye_service/publisher'
 
-end #/module
+if defined? ::Rails::Railtie
+	require 'faye_service/railtie'
+end #/if

data/lib/faye_service/config.rb

@@ -0,0 +1,28 @@
+module FayeService
+	class << self
+		def configure
+			yield config
+		end #/def
+
+		def config
+			@_config ||= Config.new
+		end #/def
+	end #/class
+
+	class Config
+		attr_accessor :url, :auth_token, :auth_service, :origin, :use_ssl
+		attr_writer :param_name
+
+		def initialize
+			@url = "http://localhost:4242"
+			@auth_token = nil
+			@auth_service = nil
+			@origin = "http://localhost:3000"
+			@use_ssl = false
+		end #/def
+
+		def param_name
+			@param_name.respond_to?(:call) ? @param_name.call : @param_name
+		end #/def
+	end #/class
+end #/module

data/lib/faye_service/logger.rb

@@ -0,0 +1,10 @@
+require 'logging'
+module FayeService
+	class << self
+		def logger
+			@logger ||= Logging.logger(STDOUT)
+			@logger.level = :warn
+			return @logger
+		end #/def
+	end #/class
+end #/module

data/lib/faye_service/publisher.rb

@@ -1,40 +1,72 @@
+require 'net/http'
+require 'json'
 module FayeService
-	module Publisher
+	class Publisher
 		class << self
 			# Creates a new HTTP Request with the channel and message to broadcast to any potential channel subscribers
-      #
-      # channel => String
-      # => Channel must be structured like: 
-      #    /channel/name
-      #    /parent/child
-      #    /parent/child1/child2
-      #    /parent/child1/child2/child3
-      #    /parent/child1/child2/child3/child4
-      #    /parent/child1/child2/child3/child4/child5
-      #    /parent/child1/child2/child3/child4/child5/child6
-      # => Channels can only go 6 children deep
-      # => Channels must be between 3 and 32 characters in length
-      # => Channels can only contain abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUBWXYV0123456789-
-      #
-      # message => String, Array, or Hash
-      # => Will be parsed into JSON
-      # => Should be less than 10KB in size (no programmed limit)
-			def publish(channel,message)
-				if channel =~ %r{^(/[\w-]{3,32}\/[\w-]{3,32}?(\/[\w-]{3,32})?(\/[\w-]{3,32})?(\/[\w-]{3,32})?(\/[\w-]{3,32})?(\/[\w-]{3,32})?)$}
-					message = {
+			#
+			# channel => String
+			# => Channel must be structured like: 
+			#    /channel/name
+			#    /parent/child
+			#    /parent/child1/child2
+			#    /parent/child1/child2/child3
+			#    /parent/child1/child2/child3/child4
+			#    /parent/child1/child2/child3/child4/child5
+			#    /parent/child1/child2/child3/child4/child5/child6
+			#    identifier-identifier-identifier
+			#    identifier-identifier-identifier-identifier
+			#    identifier-identifier-identifier-identifier-identifier
+			#    identifier-identifier-identifier-identifier-identifier-identifier
+			#    identifier-identifier-identifier-identifier-identifier-identifier-identifier
+			# => Channels can only go 6 children deep
+			# => Channels must be between 3 and 32 characters in length
+			# => Channels can only contain abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUBWXYV0123456789-
+			#
+			# message => String, Array, or Hash
+			# => Will be parsed into JSON
+			# => Should be less than 10KB in size (no programmed limit)
+			
+			def publish(channel, message)
+				FayeService.logger.debug "Attempting to send #{message.length} bytes to #{channel}."
+				if channel =~ %r{^(/[\w-]{3,32}\/[\w-]{3,32}?(\/[\w-]{3,32})?(\/[\w-]{3,32})?(\/[\w-]{3,32})?(\/[\w-]{3,32})?(\/[\w-]{3,32})?)$} || channel =~ %r{^([\w-]{3,32}[\w-]{3,32}?([\w-]{3,32})?([\w-]{3,32})?([\w-]{3,32})?([\w-]{3,32})?([\w-]{3,32})?)$}
+					payload = {
 						:channel => channel,
 						:data => message,
 						:ext => {
-							:auth_token => FayeService::auth_token,
-							:auth_service => FayeService::auth_service
+							:auth_token => FayeService.config.auth_token,
+							:auth_service => FayeService.config.auth_service
 						}
 					}
-					uri = URI.parse(FayeService::url)
-					http_result = Net::HTTP.post_form(uri, :message => message.to_json)
-					return http_result.body
+					headers = {
+						"Origin": FayeService.config.origin
+					}
+					uri = URI.parse(FayeService.config.url)
+					response = nil
+					Net::HTTP.start(uri.host, uri.port, use_ssl: FayeService.config.use_ssl) do |http|
+						req = Net::HTTP::Post.new(uri)
+						req['Content-Type'] = 'application/json'
+						req['Referrer'] = FayeService.config.origin
+						req.body = payload.to_json
+						response = http.request(req)
+					end #/block
+					return {
+						success: true,
+						uri: uri.to_json,
+						channel: channel,
+						data: message,
+						info: "Sending message to #{channel} via #{uri}.",
+						response: response
+					}
+				else
+					return {
+						success: false,
+						channel: channel,
+						data: message,
+						error: "Invalid channel name provided: #{channel}"
+					}
 				end #/if
 			end #/def
 		end #/class
-	end #/module
-end #/module
-
+	end
+end

data/lib/faye_service/railtie.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module FayeService
+  class Railtie < ::Rails::Railtie #:nodoc:
+    # Doesn't actually do anything. Just keeping this hook point, mainly for compatibility
+    initializer 'faye_service' do
+    end
+  end
+end

data/lib/faye_service/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module FayeService
-  VERSION = "1.0.0"
-end
+	VERSION = '1.0.1'
+end #/module

metadata

@@ -1,15 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: faye_service
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Andrei Merlescu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-24 00:00:00.000000000 Z
-dependencies: []
+date: 2019-08-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: logging
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.2
 description: Simple interface for Faye service messaging.
 email:
 - andrei+github@merlescu.net
@@ -18,10 +38,14 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- CHANGES
 - README.md
 - faye-service.gemspec
 - lib/faye_service.rb
+- lib/faye_service/config.rb
+- lib/faye_service/logger.rb
 - lib/faye_service/publisher.rb
+- lib/faye_service/railtie.rb
 - lib/faye_service/version.rb
 homepage: https://github.com/amerlescucodez/faye-service-gem
 licenses: