nofly 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 45c77aaaedc7144df4fc83360f17fb543a4e5352
+  data.tar.gz: f8125516b5ae19d4b9c7dee2a142f50998b094eb
+SHA512:
+  metadata.gz: 0b6361cdfac00400e129b9ac675323e2251200af86de8acb50917980e6ba3fc3942a9183df7c1bb36d01fd9cfbe683193a00a16047e305ca4393321acdf755ee
+  data.tar.gz: 31693f417b7bf8cb04cc27189910243414ec749f7d466f69b6b386e2918b7eda60e1d9880105d2ec24d2c18930f6c044666c86aaf9203703e335dc8a786c2860

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Josh Dean
+
+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.rdoc

@@ -0,0 +1,19 @@
+= Nofly
+
+== What is it?
+
+Nofly wraps communications about a particular event on an object in a managable and scalable structure.
+
+== Tell me more!
+
+When we send communications to users it is usually in response to an event. Users often have their own communications preferences (when/how/what).
+
+This logic can easily become complicated and so I developed Nofly to abstract it and let the core application only worry about knowing what event happened to which object/record. 
+
+==  Is using Nofly a good experience?
+
+I want it to be! Basically, in your controller (or maybe an observer or wherever you think is best) we do something like <i>Nofly.for( @sandwich ).eat</i> and then we create *notify_for_sandwich.cs* which has a function *eat* in which we do all our notification logic - i.e. check user preferences and send emails, in-app notifications, push notifications, etc.
+
+== Installation
+
+Add an autoload path for the directory you'll keep your nofly <i> config.autoload_paths += Dir["#{config.root}/app/nofly"] </i> to *application.rb*

data/Rakefile

@@ -0,0 +1,37 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Nofly'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/lib/nofly.rb

@@ -0,0 +1,11 @@
+module Nofly
+  require 'nofly/event_library'
+  def self.for(obj, options = {})
+    begin
+      Nofly.const_get("#{obj.class.to_s}Nofly").new(obj, options)
+    rescue
+      raise "Cannot nofly that. Have you forgotten to create a nofly event library for '#{obj.class.to_s}?'"
+    end
+  end
+
+end

data/lib/nofly/event_library.rb

@@ -0,0 +1,22 @@
+module Nofly
+  class EventLibrary
+    def initialize(obj, options)
+      @obj = obj
+      @options = options
+    end
+
+    private
+
+    def method_missing(method, *args, &block)
+      # enables 'foo' to return @obj if it is an instance of the Foo class
+      return @obj if @obj.class.to_s.downcase.to_sym == method
+
+      # access options' keys as if they were local variables
+      if @options[method] || @options[method.to_sym] 
+        return @options[method] || @options[method.to_sym]
+      end
+
+      super
+    end
+  end
+end

data/lib/nofly/version.rb

@@ -0,0 +1,3 @@
+module Nofly
+  VERSION = "1.0.0"
+end

data/lib/tasks/nofly_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :nofly do
+#   # Task goes here
+# end

data/spec/lib/nofly_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe Nofly do
+
+  it "should raise an exception if the nofly event library for that class cannot be found" do
+    expect { Nofly.for(Object.new) }.to raise_error
+  end
+
+  it "should return a nofly event library if that class can be found" do
+    expect( Nofly.for(Foo.new) ).to be_a_kind_of Nofly::EventLibrary
+  end
+end

data/spec/nofly/foo.rb

@@ -0,0 +1,3 @@
+class Foo
+
+end

data/spec/nofly/foo_nofly.rb

@@ -0,0 +1,12 @@
+class FooNofly < Nofly::EventLibrary
+  
+  # example of a nofly class
+
+  def created
+    # here is where we send out our notifications about the creation of a foo
+    # mailer
+    # in-app notification
+    # push notification
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+Dir["nofly/*.rb"].each {|file| require file }
+require 'nofly'

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: nofly
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Josh Dean
+- Chalkle.com
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rake
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: When we send communications to users it is usually in response to an
+  event. Users often have their own communications preferences (when/how/what). This
+  logic can easily become complicated and so I developed Nofly to abstract it and
+  let the core application only worry about knowing what event happened to which object/record.
+email:
+- jdbdean@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- lib/nofly.rb
+- lib/nofly/event_library.rb
+- lib/nofly/version.rb
+- lib/tasks/nofly_tasks.rake
+- spec/lib/nofly_spec.rb
+- spec/nofly/foo.rb
+- spec/nofly/foo_nofly.rb
+- spec/spec_helper.rb
+homepage: https://github.com/Jdbdean/nofly
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Nofly - don't write notifications on the fly. Nofly wraps communications
+  about a particular event on an object so you can write managable code.
+test_files:
+- spec/lib/nofly_spec.rb
+- spec/nofly/foo.rb
+- spec/nofly/foo_nofly.rb
+- spec/spec_helper.rb