subly 0.0.1

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+bin/*
+.idea/*

data/.rvmrc

@@ -0,0 +1 @@
+rvm --create ruby-1.8.7@subly

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 SmashTank Apps, LLC
+
+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,35 @@
+= Subly
+
+This gem provides the ability to add subscriptions to models that is controlled from an external app
+
+== Usage
+subly accepts a single optional parameter of :is_methods
+  class Item < ActiveRecord::Base
+    subly :is_methods => [:premium, :standard]
+  end
+
+== Migration
+See the last todo, this needs to me a generator/rake task but I am tired and want to goto sleep
+  create_table :subly_models do |t|
+    t.string    :subscriber_type
+    t.integer   :subscriber_id
+    t.string    :name
+    t.string    :value
+    t.datetime  :starts_at
+    t.datetime  :ends_at
+  end
+  add_index :subly_models, [:subscriber_type,:subscriber_id], :name => 'subscriber_idx'
+  add_index :subly_models, :starts_at, :name => 'starts_idx'
+  add_index :subly_models, :ends_at, :name => 'ends_idx'
+
+== Todo
+*  maybe add a controller
+*  do something with the value field, I think it useful but can't think of a use case yet.
+*  make the doco usefull
+*  make a generator for rails 2 and 3
+
+== Copyright
+
+Copyright (c) 2011 SmashTank Apps, LLC. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/subly.rb

@@ -0,0 +1,57 @@
+require "subly/version"
+require "subly/model"
+
+module Subly
+  def subly(args = {})
+    self.has_many :sublies, :as => :subscriber, :class_name => 'Subly::Model'
+    self.accepts_nested_attributes_for :sublies, :allow_destroy => true, :reject_if => :all_blank
+
+    #we don't want to use method missing for all "is" methods
+    if is_methods = args.delete(:is_methods)
+      is_methods.collect(&:to_s).each do |is_name|
+        if self.instance_methods.include?(is_name)
+          warn("Subly: Method is_#{is_name}? is already available to #{self.class.to_s}")
+        else
+          self.class_eval <<-EOV
+            def is_#{is_name}?
+              self.has_active_subscription?('#{is_name}')
+            end
+          EOV
+        end
+      end
+    end
+
+    extend ClassMethods
+    include InstanceMethods
+  end
+
+  module ClassMethods
+    def with_subscription(name)
+      scoped(:include => :sublies, :conditions => {:subly_models => {:name => name}})
+    end
+
+    def with_active_subscription(name)
+      now = Time.now
+      with_subscription(name).scoped(:joins => :sublies, :conditions => ['subly_models.starts_at <= ? AND (ends_at IS NULL or ends_at > ?)', now, now])
+    end
+  end
+
+  module InstanceMethods
+    def add_subscription(name, args = {})
+      value = args[:value] || nil
+      start_date = args[:start_date] || Time.now
+      end_date = args[:end_date] || nil
+      self.sublies.create(:name => name, :value => value, :starts_at => start_date, :ends_at => end_date)
+    end
+
+    def has_subscription?(name)
+      self.sublies.by_name(name).count > 0
+    end
+
+    def has_active_subscription?(name)
+      self.sublies.active.by_name(name).count > 0
+    end
+  end
+end
+
+ActiveRecord::Base.send :extend, Subly

data/lib/subly/model.rb

@@ -0,0 +1,37 @@
+module Subly
+  class Model < ActiveRecord::Base
+    set_table_name 'subly_models'
+
+    belongs_to :subscriber, :polymorphic => true
+
+    validates_presence_of :subscriber_type
+    validates_presence_of :subscriber_id, :unless => Proc.new { |subly| subly.subscriber_type.nil? }
+    validate :ends_after_starts
+
+    def self.active
+      now = Time.now
+      scoped(:conditions => ['starts_at <= ? AND (ends_at > ? OR ends_at IS NULL)', now, now])
+    end
+
+    def self.expired
+      now = Time.now
+      scoped(:conditions => ['starts_at <= ? AND ends_at <= ?', now, now])
+    end
+
+    def self.for_subscriber(sub)
+      raise ArgumentError('wrong number of arguments (0 for 1)') if sub.blank?
+      scoped(:conditions => ['subscriber_type = ? AND subscriber_id = ?',sub.class.to_s, sub.id])
+    end
+
+    def self.by_name(name)
+      scoped(:conditions => {:name => name})
+    end
+
+    private
+    def ends_after_starts
+      unless ends_at.nil? || (ends_at > starts_at)
+        raise "ends_at must be after starts_at"
+      end
+    end
+  end
+end

data/lib/subly/version.rb

@@ -0,0 +1,3 @@
+module Subly
+  VERSION = "0.0.1"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,43 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'active_record'
+require 'rspec'
+require 'subly'
+require 'sqlite3'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+#ActiveRecord::Schema.verbose = false
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+
+ActiveRecord::Base.configurations = true
+ActiveRecord::Schema.define(:version => 1) do
+  create_table :items do |t|
+    t.datetime  :created_at
+    t.datetime  :updated_at
+    t.string    :name
+    t.string    :description
+  end
+
+  create_table :things do |t|
+    t.datetime  :created_at
+    t.datetime  :updated_at
+    t.string    :name
+    t.string    :description
+  end
+
+  create_table :subly_models do |t|
+    t.datetime  :archived_at
+    t.string    :subscriber_type
+    t.integer   :subscriber_id
+    t.string    :name
+    t.string    :value
+    t.datetime  :starts_at
+    t.datetime  :ends_at
+  end
+  add_index :subly_models, [:subscriber_type,:subscriber_id], :name => 'subscriber_idx'
+  add_index :subly_models, :starts_at, :name => 'starts_idx'
+  add_index :subly_models, :ends_at, :name => 'ends_idx'
+end

data/spec/subly_model_spec.rb

@@ -0,0 +1,23 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+class Item < ActiveRecord::Base
+  subly
+end
+
+class Thing < ActiveRecord::Base
+  subly
+end
+
+describe Subly::Model do
+  it "should not create a subscription without a subscriber_id" do
+    lambda{Subly::Model.create!(:name => 'Foo', :subscriber_type => 'Boo')}.should raise_error
+  end
+
+  it "should not create a subscription without a subscriber" do
+    lambda{Subly::Model.create!(:name => 'Foo', :subscriber_id => 3)}.should raise_error
+  end
+
+  it "subscription should not be created when ends before starts" do
+    lambda{Subly::Model.create!(:name => 'Foo', :subscriber_type => 'Foo', :subscriber_id => 1, :starts_at => Time.now + 1.minute, :ends_at => Time.now - 1.minute)}.should raise_error
+  end
+end

data/spec/subly_spec.rb

@@ -0,0 +1,62 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+class Item < ActiveRecord::Base
+  subly :is_methods => [:subby]
+end
+
+class Thing < ActiveRecord::Base
+  subly
+end
+
+describe Subly do
+  it "should add a subscription" do
+    thing_one = Thing.create(:name => 'Thing One', :description => 'foo')
+    thing_one.add_subscription('sub name','sub value').should be_true
+    thing_one.reload
+    thing_one.sublies.count.should == 1
+  end
+
+  it "subscription should default to active" do
+    thing_one = Thing.create(:name => 'Thing One', :description => 'foo')
+    thing_one.add_subscription('sub name').should be_true
+    thing_one.reload
+    thing_one.has_active_subscription?('sub name').should be_true
+  end
+
+  it "has_subscription should return true even for expired subscription" do
+    thing_one = Thing.create(:name => 'Thing One', :description => 'foo')
+    thing_one.add_subscription('sub name', :start_date => Time.now - 1.day, :end_date => Time.now - 2.hours).should be_true
+    thing_one.reload
+    thing_one.has_subscription?('sub name').should be_true
+  end
+
+
+  it "should find models with active subscription" do
+    Thing.delete_all
+    thing_one = Thing.create(:name => 'Thing One', :description => 'foo')
+    thing_one.add_subscription('sub name').should be_true
+    Thing.with_active_subscription('sub name').should == [thing_one]
+  end
+
+  it "should find models with even expired subscriptions" do
+    Thing.delete_all
+    thing_one = Thing.create(:name => 'Thing One', :description => 'foo')
+    thing_one.add_subscription('sub name', :start_date => Time.now - 1.day, :end_date => Time.now - 2.hours).should be_true
+    Thing.with_subscription('sub name').should == [thing_one]
+    thing_one.destroy
+  end
+
+  it "should define methods for is" do
+    Item.instance_method(:is_subby?).should be_true
+  end
+
+  it "is method should be false if it does not have an active sub" do
+    Item.new.is_subby?.should be_false
+  end
+
+  it "is method should be true if it has an active sub" do
+    item = Item.create(:name => 'foo')
+    item.add_subscription('subby')
+    item.is_subby?.should be_true
+  end
+end

data/subly.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "subly/version"
+
+Gem::Specification.new do |s|
+  s.name        = "subly"
+  s.version     = Subly::VERSION
+  s.authors     = ['SmashTank Apps, LLC','Eric Harrison']
+  s.email       = ['dev@smashtankapps.com']
+  s.homepage    = "http://github.com/smashtank/subly"
+  s.summary     = %q{Add subscriptions to a model that are controlled externally}
+  s.description = %q{This was purpose built to extend models with subscriptions that were controlled via SalesForce}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_paths = ["lib"]
+
+  s.required_rubygems_version = ">= 1.3.6"
+  s.add_development_dependency "activerecord", "~> 2.3.12"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "sqlite3"
+
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: subly
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- SmashTank Apps, LLC
+- Eric Harrison
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-12-02 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &2153605660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.12
+  type: :development
+  prerelease: false
+  version_requirements: *2153605660
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2153605280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2153605280
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &2153604820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2153604820
+description: This was purpose built to extend models with subscriptions that were
+  controlled via SalesForce
+email:
+- dev@smashtankapps.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- lib/subly.rb
+- lib/subly/model.rb
+- lib/subly/version.rb
+- spec/spec_helper.rb
+- spec/subly_model_spec.rb
+- spec/subly_spec.rb
+- subly.gemspec
+homepage: http://github.com/smashtank/subly
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Add subscriptions to a model that are controlled externally
+test_files:
+- spec/spec_helper.rb
+- spec/subly_model_spec.rb
+- spec/subly_spec.rb