scripter 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 22716daa173876308969ce95a93267e6c84ca0f4
+  data.tar.gz: 791bde4324ef837160d794458bc168145e658d61
+SHA512:
+  metadata.gz: b050f637350bc367bbe0f05e9b96d87b22b54689da5353e9a1ce367d27f1ffae1ee4a1d6202e2f94d3ce0caacbd23acf62eb3d2f9b3ae8e37b4d73740785aa72
+  data.tar.gz: 2e5876825ccc3d10ed0c9c4fb4014f06a84eeaeb8a99ea150cf4335bf8dd5babaa04d4b7e62753db1cbda78c61d4c9e8f5ab46b21a44b5ac6e592d1b0bebd5a1

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Artūrs Mekšs
+
+MIT License
+
+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,52 @@
+# Scripter
+
+Library for reducing of boilerplate in ruby scripts with possibility to run fault tolerant iterations, for example mass notifications, or support scripts
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'scripter'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install scripter
+
+## Usage
+
+Usage example:
+```ruby
+class MyScripterEnabledClass < Scripter::Base
+  #ENV variables which will be assigned to instance
+  env_variables :test_env
+
+  def execute
+    # your specific execution code goes here
+    # Note: use #perform_iteration helper with block in order to make fault tolerant iterations
+  end
+
+  def on_exit
+    # your reporting scripts goes here
+    # Note: #valid?, invalid?, #errors_grouped and #errors_count methods can be useful here
+  end
+end
+```
+
+Call example:
+```ruby
+MyScripterEnabledClass.execute
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/scripter/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,4 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)

data/lib/scripter/base.rb

@@ -0,0 +1,65 @@
+# -*- encoding : utf-8 -*-
+module Scripter
+  class Base
+    include Scripter::Errors
+    include Scripter::Logger
+    include Scripter::EnvVariables
+    include Scripter::IterationHistory
+
+    env_variables :use_cache, :dry_run, :force_run
+
+    def self.set_custom_executable_name(name)
+      class_eval %{
+        def self.#{name}
+          self.execute(:#{name})
+        end
+      }
+    end
+
+    def initialize
+      yield self if block_given?
+      self
+    end
+
+    def self.execute(iteration_function_name=:execute)
+      self.new do |scripter_instance|
+        # exits immediately without raising an exception on ctrl+c
+        trap("SIGINT") { exit! }
+
+        scripter_instance.with_fault_monitoring do
+          scripter_instance.instance_variable_set :@iteration_idx, 0
+          scripter_instance.public_send(iteration_function_name)
+        end
+
+        scripter_instance.on_exit if scripter_instance.respond_to?(:on_exit)
+      end
+    end
+
+    def with_fault_monitoring
+      log :info, "==============================================   START   =============================================="
+      begin
+        log :info, "Performing: #{self.inspect}"
+        yield
+      rescue Exception => error
+        add_error(error)
+      ensure
+        log :info, "===============================================   END   ==============================================="
+      end
+    end
+
+    def perform_iteration(iteration_id, iteration_meta={}, verbose=true)
+      @iteration_idx += 1
+      begin
+        unless iteration_processed?(iteration_id)
+          yield
+          iteration_processed!(iteration_id)
+        end
+      rescue Exception => error
+        add_error(error, iteration_meta, verbose)
+        if @iteration_idx == 100 && errors_count > 50
+          raise "Iteration was interrupted as error rate was too big (#{errors_count.to_f / @iteration_idx.to_f * 100.0}%)"
+        end
+      end
+    end
+  end
+end

data/lib/scripter/cache_store.rb

@@ -0,0 +1,19 @@
+# -*- encoding : utf-8 -*-
+require 'active_support'
+
+
+module Scripter
+  class CacheStore
+    def initialize
+      @cache = defined?(Rails) ? Rails.cache : ActiveSupport::Cache.lookup_store(:file_store, 'tmp/cache')
+    end
+
+    def read(*args)
+      @cache.read(*args)
+    end
+
+    def write(*args)
+      @cache.write(*args)
+    end
+  end
+end

data/lib/scripter/env_variables.rb

@@ -0,0 +1,55 @@
+# -*- encoding : utf-8 -*-
+module Scripter
+  module EnvVariables
+
+    def self.included(receiver)
+      receiver.extend ClassMethods
+    end
+
+    module ClassMethods
+      def env_variables(*variables)
+        variables.each do |env_variable|
+          class_eval %{
+            def #{env_variable}
+              env_variables[:#{env_variable}]
+            end
+          }
+        end
+      end
+    end
+
+    def raw_env_variables
+      Hash[command_line_arguments.select{|arg| arg.include?('=')}.map{|arg| arg.split("=")}]
+    end
+
+    def env_variables
+      @env_variables ||= begin
+        env_variables = raw_env_variables.map do |key, value|
+          nomalized_key = key.downcase.to_sym
+          [nomalized_key, type_cast_env_variable(nomalized_key, value)]
+        end
+        Hash[env_variables]
+      end
+    end
+
+    # You can override this method in order to add additional typecasts for custom params,
+    # but don't forget to call super in else block of your switch statement
+    def type_cast_env_variable(name, value)
+      case name
+      when :date
+        ::Date.parse(value, false) unless value.to_s.empty?
+      when :dry_run, :force_run, :use_cache
+        !value.to_s.empty?
+      else
+        value
+      end
+    end
+
+private
+
+    def command_line_arguments
+      @command_line_arguments ||= ARGV
+    end
+
+  end
+end

data/lib/scripter/errors.rb

@@ -0,0 +1,38 @@
+# -*- encoding : utf-8 -*-
+module Scripter
+  module Errors
+
+    def errors
+      @errors ||= []
+    end
+
+    def errors_grouped
+      @errors_grouped ||= errors.group_by{|err| err[:category] }
+    end
+
+    def errors_count
+      errors.count
+    end
+
+    def valid?
+      errors.empty?
+    end
+
+    def invalid?
+      !valid?
+    end
+
+    def add_error(error, meta_hash={}, error_to_log=true)
+      error_hash = normalize_error(error)
+      log_error(error_hash) if error_to_log
+      errors << error_hash.merge(meta_hash)
+    end
+
+private
+
+    def normalize_error(error)
+      error.is_a?(Hash) ? error : { message: error.to_s, category: error.backtrace }
+    end
+
+  end
+end

data/lib/scripter/iteration_history.rb

@@ -0,0 +1,27 @@
+# -*- encoding : utf-8 -*-
+module Scripter
+  module IterationHistory
+
+    attr_writer :cache_store
+    def cache_store
+      @cache_store ||= Scripter::CacheStore.new
+    end
+
+    def iteration_processed!(iteration_item_id)
+      return if iteration_item_id.to_s.empty?
+      cache_store.write(calculate_cache_key(iteration_item_id), true, expires_in: 24 * 3600)
+    end
+
+    def iteration_processed?(iteration_item_id)
+      return false unless use_cache
+      !!cache_store.read(calculate_cache_key(iteration_item_id))
+    end
+
+private
+
+    def calculate_cache_key(iteration_item_id)
+      "#{self.class}_#{iteration_item_id}"
+    end
+
+  end
+end

data/lib/scripter/logger.rb

@@ -0,0 +1,29 @@
+# -*- encoding : utf-8 -*-
+require 'logger'
+
+module Scripter
+  module Logger
+
+    attr_writer :logger
+    def logger
+      @logger ||= ::Logger.new(STDOUT)
+    end
+
+    def log(type, message)
+      logger.send(type, message)
+    end
+
+    def log_title(message)
+      log :info, "--------------------------------------------------------------------"
+      log :info, "|     #{message}"
+      log :info, "--------------------------------------------------------------------"
+    end
+
+    def log_error(error)
+      log :error, "\n ----------------------------- #{error.fetch(:message)} -----------------------------"
+      log :error, "#{error.fetch(:category)} \n"
+      log :error, "-------------------------------------------------------------------- \n"
+    end
+
+  end
+end

data/lib/scripter/version.rb

@@ -0,0 +1,4 @@
+# -*- encoding : utf-8 -*-
+module Scripter
+  VERSION = "0.0.1"
+end

data/lib/scripter.rb

@@ -0,0 +1,33 @@
+require 'scripter/version'
+require 'scripter/cache_store'
+require 'scripter/iteration_history'
+require 'scripter/env_variables'
+require 'scripter/logger'
+require 'scripter/errors'
+require 'scripter/base'
+
+# Library for reducing of boilerplate in ruby scripts with possibility to run fault tolerant iterations, for example mass notifications, or support scripts
+#
+# Usage example:
+# class MyScriptClass < Scripter::Base
+#   #ENV variables which will be assigned to instance
+#   env_variables :test_env
+#
+#   def execute
+#     # your specific execution code goes here
+#     # Note: use #perform_iteration helper with block in order to make fault tolerant iterations
+#   end
+#
+#   def on_exit
+#     # your reporting scripts goes here
+#     # Note: #valid?, invalid?, #errors_grouped and #errors_count methods can be useful here
+#   end
+# end
+#
+# Call example:
+# MyScriptClass.execute
+#
+
+module Scripter
+
+end

data/scripter.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'scripter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "scripter"
+  spec.version       = Scripter::VERSION
+  spec.authors       = ["Artūrs Mekšs"]
+  spec.email         = ["arturs.mekss@gmail.com"]
+  spec.summary       = %q{Library for reducing of boilerplate in ruby scripts with possibility to run fault tolerant iterations}
+  spec.description   = %q{Library for reducing of boilerplate in ruby scripts with possibility to run fault tolerant iterations, for example mass notifications, or support scripts}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'timecop', '~> 0.7.1'
+
+  spec.add_dependency 'activesupport', '>= 2'
+end

data/spec/scripter/base_spec.rb

@@ -0,0 +1,138 @@
+# -*- encoding : utf-8 -*-
+require 'spec_helper'
+
+class Scripter::BaseTestable < Scripter::Base
+  env_variables :test_variable1, :test_variable2
+  attr_reader :was_executed, :iteration_count
+  def execute
+    @was_executed = true
+    @iteration_count = 0
+  end
+end
+
+class Scripter::BaseTestableWithCustomName < Scripter::BaseTestable
+  set_custom_executable_name :distribute
+  def distribute
+    @was_executed = true
+  end
+end
+
+describe Scripter::Base do
+  it "should have getters for to default environment variables" do
+    expect(subject).to respond_to(:use_cache)
+    expect(subject).to respond_to(:dry_run)
+    expect(subject).to respond_to(:force_run)
+  end
+
+  it "should have Errors, Logger, EnvVariables and IterationHistory modules included" do
+    expect(subject).to respond_to(:add_error)
+    expect(subject).to respond_to(:log)
+    expect(subject).to respond_to(:env_variables)
+    expect(subject).to respond_to(:cache_store)
+  end
+
+  it "should invoke instance method execute on execute class method call" do
+    scripter = Scripter::BaseTestable.execute
+    expect(scripter.was_executed).to be true
+    expect(scripter).to respond_to(:test_variable1)
+    expect(scripter).to respond_to(:test_variable2)
+  end
+
+  it "should be able to customize default iteration function name" do
+    scripter = Scripter::BaseTestableWithCustomName.distribute
+    expect(scripter.was_executed).to be true
+  end
+
+  context "errors handling" do
+    class Scripter::BaseTestableWithErrors < Scripter::BaseTestable
+      set_custom_executable_name :execute_with_global_error
+      set_custom_executable_name :execute_with_iteration_error
+
+      def execute_with_global_error
+        execute
+        raise "my global error"
+      end
+
+      def execute_with_iteration_error
+        execute
+
+        1000.times do |idx|
+          perform_iteration(idx, {}, false) do
+            @iteration_count += 1
+            raise "my iteration error"
+          end
+        end
+      end
+    end
+
+    before(:each) do
+      @scripter_class = Scripter::BaseTestableWithErrors
+    end
+
+    it "should stop execution on global error" do
+      scripter = @scripter_class.execute_with_global_error
+      expect(scripter.was_executed).to be true
+    end
+
+    it "should continue execute only 100 times if there is an error in each execution loop" do
+      scripter = @scripter_class.execute_with_iteration_error
+      expect(scripter.was_executed).to be true
+      expect(scripter.iteration_count).to eq 100
+    end
+  end
+
+  context "EndToEnd test" do
+    class Scripter::BaseTestableEndToEnd < Scripter::BaseTestable
+      attr_reader :on_exit_was_called
+      set_custom_executable_name :execute_with_loop
+
+      def execute_with_loop
+        execute
+
+        10.times do |idx|
+          perform_iteration(idx, {additional: 'info'}, false) do
+            @iteration_count += 1
+            raise "my iteration error nr #{idx}" if idx == 5
+          end
+        end
+      end
+
+      def on_exit
+        @on_exit_was_called = true
+      end
+    end
+
+    before(:each) do
+      @scripter_class = Scripter::BaseTestableEndToEnd
+    end
+
+    it "should execute all iterations every time called" do
+      scripter = @scripter_class.execute_with_loop
+      expect(scripter.iteration_count).to eq 10
+      scripter = @scripter_class.execute_with_loop
+      expect(scripter.iteration_count).to eq 10
+    end
+
+    it "should execute only failed iterations if cache enabled" do
+      allow_any_instance_of(@scripter_class).to receive(:use_cache).and_return(true)
+      scripter = @scripter_class.execute_with_loop
+      expect(scripter.iteration_count).to eq 10
+      scripter = @scripter_class.execute_with_loop
+      expect(scripter.iteration_count).to eq 1
+    end
+
+    it "should contain information about the failure including meta info" do
+      scripter = @scripter_class.execute_with_loop
+      error = scripter.errors.first
+      expect(error[:message]).to eq 'my iteration error nr 5'
+      expect(error[:additional]).to eq 'info'
+      expect(error[:category]).to_not be_nil
+    end
+
+    it "should call on_exit if defined" do
+      scripter = @scripter_class.execute_with_loop
+      expect(scripter.on_exit_was_called).to be true
+    end
+  end
+
+end

data/spec/scripter/env_variables_spec.rb

@@ -0,0 +1,68 @@
+# -*- encoding : utf-8 -*-
+require 'spec_helper'
+
+class Scripter::EnvVariablesTestable
+  include Scripter::EnvVariables
+
+  # custom type casts test
+  def type_cast_env_variable(name, value)
+    if name == :countries
+      value.split(/\s*,\s*/)
+    else
+      super
+    end
+  end
+end
+
+describe Scripter::EnvVariables do
+  before(:each) do
+    @it = Scripter::EnvVariablesTestable.new
+  end
+
+  describe "::env_variables" do
+    it "should be available" do
+      expect(@it.class.respond_to?(:env_variables)).to be true
+    end
+
+    it "should be able to add new Environment variable getters" do
+      expect(@it.respond_to?(:test_variable)).to be false
+      @it.class.send :env_variables, :test_variable
+      expect(@it).to receive(:env_variables).and_return({test_variable: 'something'})
+      expect(@it.test_variable).to eq 'something'
+    end
+  end
+
+  context "with stubbed arguments" do
+    before(:each) do
+      expect(@it).to receive(:command_line_arguments).and_return(['notifications', 'RAILS_ENV=test', 'COUNTRIES=LV,EE,FI', 'use_cache=1'])
+    end
+
+    it "#raw_env_variables should return only variables" do
+      expect(@it.raw_env_variables).to eq({'RAILS_ENV'=>'test', 'COUNTRIES'=>'LV,EE,FI', 'use_cache'=>'1'})
+    end
+
+    it "#env_variables should return normalized type casted variables" do
+      expect(@it.env_variables).to eq({rails_env: 'test', countries: ['LV', 'EE', 'FI'], use_cache: true})
+    end
+  end
+
+  describe "#type_cast_env_variable" do
+    it ":date should be date or nil" do
+      expect(@it.type_cast_env_variable(:date, nil)).to be_nil
+      expect(@it.type_cast_env_variable(:date, '2014-04-14')).to eq Date.new(2014, 4, 14)
+    end
+
+    [:dry_run, :force_run, :use_cache].each do |variable_name|
+      it ":#{variable_name} should be boolean" do
+        expect(@it.type_cast_env_variable(variable_name, nil)).to be false
+        expect(@it.type_cast_env_variable(variable_name, '')).to be false
+        expect(@it.type_cast_env_variable(variable_name, '1')).to be true
+      end
+    end
+  end
+
+  it "#command_line_arguments should return ARGV" do
+    expect(@it.send(:command_line_arguments)).to be ARGV
+  end
+
+end

data/spec/scripter/errors_spec.rb

@@ -0,0 +1,96 @@
+# -*- encoding : utf-8 -*-
+require 'spec_helper'
+
+class Scripter::ErrorsTestable
+  include Scripter::Errors
+  include Scripter::Logger
+
+  def raise_test_exception
+    begin
+      raise "test error"
+    rescue Exception => e
+      add_error(e, {}, false)
+    end
+  end
+
+end
+
+describe Scripter::Errors do
+  before(:each) do
+    @it = Scripter::ErrorsTestable.new
+  end
+
+  it "should provide errors array" do
+    expect(@it).to respond_to(:errors)
+    expect(@it.errors).to be_instance_of(Array)
+  end
+
+  it "should provide errors_grouped array groped by category" do
+    @it.errors << {category: 'test category', message: 'test message'}
+    @it.errors << {category: 'test category', message: 'test message1'}
+    @it.errors << {category: 'test category', message: 'test message2'}
+    @it.errors << {category: 'test category1', message: 'test message2'}
+
+    expect(@it.respond_to?(:errors_grouped)).to be true
+    expect(@it.errors_grouped).to be_instance_of(Hash)
+    expect(@it.errors_grouped['test category'].size).to eq 3
+  end
+
+  it "#errors_count should return count of stored errors" do
+    expect(@it.errors_count).to eq 0
+    @it.errors << {category: 'test category', message: 'test message'}
+    expect(@it.errors_count).to eq 1
+    @it.errors << {category: 'test category', message: 'test message1'}
+    expect(@it.errors_count).to eq 2
+  end
+
+  describe "#valid?" do
+    it "should be true if no errors stored" do
+      expect(@it.valid?).to be true
+    end
+
+    it "should be false if there are errors" do
+      @it.errors << {category: 'test category', message: 'test message'}
+      expect(@it.valid?).to be false
+    end
+  end
+
+  describe "#invalid?" do
+    it "should be false if no errors stored" do
+      expect(@it.invalid?).to be false
+    end
+
+    it "should be true if there are errors" do
+      @it.errors << {category: 'test category', message: 'test message'}
+      expect(@it.invalid?).to be true
+    end
+  end
+
+  describe "#add_error" do
+    before(:each) do
+      expect(@it.errors).to be_empty
+      @errors_hash = {category: 'error', message: 'some'}
+    end
+
+    it "should be able to log incoming error if error_to_log is true" do
+      expect(@it).to receive(:log_error).once.with(@errors_hash)
+      @it.add_error(@errors_hash, {}, true)
+      @it.add_error(@errors_hash, {}, false)
+    end
+
+    it "should add meta information to error if passed along" do
+      @it.add_error(@errors_hash, {add: 'info'}, false)
+      expect(@it.errors.first).to eq({category: 'error', message: 'some', add: 'info'})
+    end
+
+    it "should be able to add error from exception" do
+      @it.raise_test_exception
+
+      expect(@it.errors).not_to be_empty
+      error = @it.errors.first
+      expect(error[:message]).to eq 'test error'
+      expect(error[:category]).to be_a Array
+    end
+  end
+
+end

data/spec/scripter/iteration_history_spec.rb

@@ -0,0 +1,71 @@
+# -*- encoding : utf-8 -*-
+require 'spec_helper'
+
+class Scripter::IterationHistoryTestable
+  include Scripter::IterationHistory
+  attr_accessor :use_cache
+end
+
+class Scripter::IterationHistoryTestable2
+  include Scripter::IterationHistory
+  attr_accessor :use_cache
+end
+
+describe Scripter::IterationHistory do
+  before(:each) do
+    @it = Scripter::IterationHistoryTestable.new
+    @it.use_cache = true
+  end
+
+  it "should be able to set custom cache store" do
+    @it.cache_store = 'My custom cache_store'
+    expect(@it.cache_store).to eq 'My custom cache_store'
+  end
+
+  describe "#iteration_processed! and #iteration_processed?" do
+    it "should share cache between instances of the same class" do
+      expect(@it.iteration_processed?(1)).to be false
+
+      another_it = Scripter::IterationHistoryTestable.new
+      another_it.iteration_processed!(1)
+
+      expect(@it.iteration_processed?(1)).to be true
+    end
+
+    it "should not share cache between instances of different classes" do
+      expect(@it.iteration_processed?(1)).to be false
+
+      another_class_it = Scripter::IterationHistoryTestable2.new
+      another_class_it.use_cache = true
+      another_class_it.iteration_processed!(1)
+
+      expect(another_class_it.iteration_processed?(1)).to be true
+      expect(@it.iteration_processed?(1)).to be false
+    end
+
+    it "should remember results for 24 hours" do
+      @it.iteration_processed!(1)
+      expect(@it.iteration_processed?(1)).to be true
+
+      Timecop.travel(Time.now + 24.hours) do
+        expect(@it.iteration_processed?(1)).to be false
+      end
+    end
+
+    it "should be different for different iteration_id" do
+      expect(@it.iteration_processed?(1)).to be false
+      expect(@it.iteration_processed?(2)).to be false
+      @it.iteration_processed!(1)
+      expect(@it.iteration_processed?(1)).to be true
+      expect(@it.iteration_processed?(2)).to be false
+    end
+
+    it "should always be unprocessed if #use_cache is false" do
+      @it.use_cache = false
+      expect(@it.iteration_processed?(1)).to be false
+      @it.iteration_processed!(1)
+      expect(@it.iteration_processed?(1)).to be false
+    end
+  end
+
+end

data/spec/scripter/logger_spec.rb

@@ -0,0 +1,64 @@
+# -*- encoding : utf-8 -*-
+require 'spec_helper'
+
+class Scripter::LoggerTestable
+  include Scripter::Logger
+end
+
+describe Scripter::Logger do
+  before(:each) do
+    @it = Scripter::LoggerTestable.new
+  end
+
+  it "should be able to set custom logger" do
+    @it.logger = 'My custom logger'
+    expect(@it.logger).to eq 'My custom logger'
+  end
+
+  describe "#log" do
+    it "should be available" do
+      expect(@it.respond_to?(:log)).to be true
+    end
+
+    [:info, :debug, :error].each do |type|
+      it "should be able to log #{type}" do
+        expect(@it.logger).to receive(type).with('log message')
+        @it.log type, 'log message'
+      end
+    end
+  end
+
+  describe "#log_title" do
+    it "should be available" do
+      expect(@it.respond_to?(:log_title)).to be true
+    end
+
+    it "should log title as info" do
+      messages = []
+      expect(@it).to receive(:log).exactly(3).times do |type, message|
+        messages << message
+        expect(type).to be :info
+      end
+      @it.log_title "test title"
+      expect(messages.join.include?("test title")).to be true
+    end
+  end
+
+  describe "#log_error" do
+    it "should be available" do
+      expect(@it.respond_to?(:log_error)).to be true
+    end
+
+    it "should log error message as error" do
+      messages = []
+      expect(@it).to receive(:log).exactly(3).times do |type, message|
+        messages << message
+        expect(type).to be :error
+      end
+      @it.log_error({category: "my test category", message: "my test message"})
+      expect(messages.join.include?("my test category")).to be true
+      expect(messages.join.include?("my test message")).to be true
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,96 @@
+require 'scripter'
+require 'timecop'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.before(:each) do
+    FileUtils.rm_rf(Dir['tmp/cache'])
+  end
+
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: scripter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Artūrs Mekšs
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
+description: Library for reducing of boilerplate in ruby scripts with possibility
+  to run fault tolerant iterations, for example mass notifications, or support scripts
+email:
+- arturs.mekss@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/scripter.rb
+- lib/scripter/base.rb
+- lib/scripter/cache_store.rb
+- lib/scripter/env_variables.rb
+- lib/scripter/errors.rb
+- lib/scripter/iteration_history.rb
+- lib/scripter/logger.rb
+- lib/scripter/version.rb
+- scripter.gemspec
+- spec/scripter/base_spec.rb
+- spec/scripter/env_variables_spec.rb
+- spec/scripter/errors_spec.rb
+- spec/scripter/iteration_history_spec.rb
+- spec/scripter/logger_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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: Library for reducing of boilerplate in ruby scripts with possibility to run
+  fault tolerant iterations
+test_files:
+- spec/scripter/base_spec.rb
+- spec/scripter/env_variables_spec.rb
+- spec/scripter/errors_spec.rb
+- spec/scripter/iteration_history_spec.rb
+- spec/scripter/logger_spec.rb
+- spec/spec_helper.rb