realtime_change 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aea8e688ad7161963e3892b5b64d6ecd5abc3b6e
+  data.tar.gz: 4917a8685d6a608108f35028fb5c1f9fe3ca5c33
+SHA512:
+  metadata.gz: bac4aa2988b8b701bb3bbed04daccec1cb3710d9e58faa8bc46b0b29cf95ab3f21d09dce042c854b3d07a26d35c746dca40b11b703088b4640eecdd53e6a08ee
+  data.tar.gz: b9b69758a461b6231f2ed4d271bd35342e0d9071dc9aa7ff9119bee89d1689a29f7d95213a70883a2cf252c70abfcd45540d2c43a1f49bf1a7804e4bd89ca16a

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at emesonsantana@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in realtime_change.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 emeson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,44 @@
+# RealtimeChange
+
+Gem for realtime client-server communication. Created to work with [communication-socket](https://github.com/emesonsantana/communication-socket).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'realtime_change'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install realtime_change
+
+## Usage
+
+Basic Configuration:
+```ruby
+# Configure
+RealtimeChange.setup do |config|
+  config.redis = Redis.new url: "redis://localhost:6379"
+end
+
+# Add model functionality
+if defined?(ActiveRecord::Base)
+  ActiveRecord::Base.extend RealtimeChange::Model
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/emesonsantana/realtime_change. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "realtime_change"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/realtime_change/configuration.rb

@@ -0,0 +1,11 @@
+module RealtimeChange
+  module Configuration
+    class << self
+      attr_accessor :redis
+
+      def configure
+        yield self
+      end
+    end
+  end
+end

data/lib/realtime_change/model/class_methods.rb

@@ -0,0 +1,62 @@
+module RealtimeChange
+  module Model
+    module ClassMethods
+      private
+      def notifiable_in_realtime
+        after_create :notify_create if respond_to?(:after_create)
+        after_update :notify_update if respond_to?(:after_update)
+        after_destroy :notify_destroy if respond_to?(:after_destroy)
+
+        # Define an anonymous module for all of the instance methods.
+        instance_methods = Module.new do
+          def json_to_send
+            self.to_json
+          end
+
+          def send_to
+            []
+          end
+
+          def notify_create
+            message = {
+              type: 'change',
+              action: 'create',
+              resource: self.class.name,
+              resource_content: json_to_send,
+              send_to: send_to
+            }
+            notify message
+          end
+
+          def notify_update
+            message = {
+              type: 'change',
+              action: 'update',
+              resource: self.class.name,
+              resource_content: json_to_send,
+              send_to: send_to
+            }
+            notify message
+          end
+
+          def notify_destroy
+            message = {
+              type: 'change',
+              action: 'destroy',
+              resource: self.class.name,
+              resource_content: json_to_send,
+              send_to: send_to
+            }
+            notify message
+          end
+
+          def notify(message)
+            RealtimeChange.redis.publish 'server-message', message
+          end
+        end
+
+        include instance_methods
+      end
+    end
+  end
+end

data/lib/realtime_change/model/instance_methods.rb

@@ -0,0 +1,6 @@
+module RealtimeChange
+  module Model
+    module InstanceMethods
+    end
+  end
+end

data/lib/realtime_change/model.rb

@@ -0,0 +1,11 @@
+require 'realtime_change/model/instance_methods'
+require 'realtime_change/model/class_methods'
+
+module RealtimeChange
+  module Model
+    def self.extended(klass)
+      klass.extend(ClassMethods)
+      klass.class_eval{ include InstanceMethods }
+    end
+  end
+end

data/lib/realtime_change/version.rb

@@ -0,0 +1,3 @@
+module RealtimeChange
+  VERSION = "0.1.0"
+end

data/lib/realtime_change.rb

@@ -0,0 +1,15 @@
+require "realtime_change/version"
+require "realtime_change/configuration"
+require "realtime_change/model"
+
+module RealtimeChange
+  class << self
+    def setup
+      Configuration.configure(yield)
+    end
+
+    def redis
+      Configuration.redis
+    end
+  end
+end

data/realtime_change.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'realtime_change/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "realtime_change"
+  spec.version       = RealtimeChange::VERSION
+  spec.authors       = ["Emeson Santana"]
+  spec.email         = ["emesonsantana@gmail.com"]
+
+  spec.summary       = %q{Gem for realtime client-server communication. Created to work with communication-socket.}
+  spec.description   = %q{Gem for realtime client-server communication. Created to work with communication-socket.}
+  spec.homepage      = "https://github.com/emesonsantana/realtime_change"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "redis"
+  spec.add_development_dependency "rspec", "~> 3.2"
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: realtime_change
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Emeson Santana
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-06-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: Gem for realtime client-server communication. Created to work with communication-socket.
+email:
+- emesonsantana@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/realtime_change.rb
+- lib/realtime_change/configuration.rb
+- lib/realtime_change/model.rb
+- lib/realtime_change/model/class_methods.rb
+- lib/realtime_change/model/instance_methods.rb
+- lib/realtime_change/version.rb
+- realtime_change.gemspec
+homepage: https://github.com/emesonsantana/realtime_change
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Gem for realtime client-server communication. Created to work with communication-socket.
+test_files: []