versioned_blocks 1.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MjRmZWFmZDUyZjRkMTc2NmJkYmU5ZDkyYjgzYmViZTZlMDUxZThiMA==
+  data.tar.gz: !binary |-
+    YWFjNTdiNjllYzNiMzRjYTI3OTQ3NjY0ZDUyY2QxY2Y1ZTg1MDBhZg==
+SHA512:
+  metadata.gz: !binary |-
+    ZmNlODVjNGI0OGMzZjBmNTkwZTk3ZTYzNDAzYTZjMDFhODI2NjI2NWFhMGNl
+    NGNlYTM1ZjkxNmZlMTg4N2Q1NWJmMzhiMWU2OTQ1OGFmYTNjZjI5ZjhjMmE1
+    ODJjMmM3MTlhNTNmOTEzMzM1MjFhMDg4M2M5MTNhYzA1NTRmYzA=
+  data.tar.gz: !binary |-
+    NmUyYmRlZjA0NTNiMWZjNTg1NWI5YzM1ZjgxYzhlNDllOTU0YTYzZjQyZjYy
+    OTQxNjRjYWI2MzRmZTNjYmVhZTcwMGFhZTc5ZTVlZmU0NzcxNDMzMTE3MTgz
+    NjU0ODQ3YTUzOGJmZjhhODY3NjU3YTFjMTc4ZjczM2ZiOWQzNWM=

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 ddayal-fiksu
+
+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,85 @@
+# versioned_blocks
+
+Are you working with versioned APIs? Loop through them easily like this:
+
+	VersionedBlocks.base_uri = 'http://www.api.com/'
+
+	versioned_block(from: 2, to: 4) do |v, uri|
+		puts "For version #{v}, the URI is #{uri}"
+	end
+
+The block is passed the version number and a URI string formed from the base URI and the respective version number.
+
+## Usage
+
+### Specifying ranges
+
+You can specify version ranges in many ways:
+- {from: 2, to: 4} would pass 2,3,4 to the block, resulting in "http://www.api.com/v2", "http://www.api.com/v3", "http://www.api.com/v4"
+- {to: 3} would pass 1,2,3 to the block
+- {only: 6} would pass just 6 to the block
+- {these: [2,4,5]} would pass 2,4,5 to the block
+
+You can config all blocks to run over a certain range by default, like this...
+	
+	VersionedBlocks.versions = {from: 2, to: 4}
+
+	versioned_block {|v, uri| puts "URI: #{uri}"}
+
+...and override a default range in a specific case like this:
+	
+	versioned_block(only: 5, override: true) do |v, uri|
+		puts "For version #{v}, the URI is #{uri}"
+	end
+
+### Error messages
+
+If you're using a versioned_block inside a test, for example, you might want any error messages to include some information about the version number that the test broke on. Just configure VersionedBlocks like this:
+
+	VersionedBlocks.prepend_errors = true
+
+### Configuring defaults
+
+You can set your preferences like this...
+      
+	VersionedBlocks.versions = {to: 5}
+	VersionedBlocks.base_uri = 'http://www.api.com/'
+	VersionedBlocks.prepend_errors = true
+
+...and reset them all like this:
+
+	VersionedBlocks.reset
+
+All configurations can be overridden in a specific case using `override: true`:
+
+	versioned_block(from: 1, to: 10, base_uri: 'http://new-api.com/', prepend_errors: false, override: true) do |v, uri|
+		puts "For version #{v}, the URI is now #{uri}"
+	end
+
+You can also just override one of them - the others will use their default value:
+
+	versioned_block(from: 1, to: 10, override: true) do |v, uri|
+		puts "For version #{v}, the URI is still #{uri}"
+	end
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'versioned_blocks'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install versioned_blocks
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/versioned_blocks/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,2 @@
+require "bundler/gem_tasks"
+

data/lib/versioned_blocks.rb

@@ -0,0 +1,87 @@
+class VersionedBlocks
+  VERSION = "1.0.1"
+
+  class << self
+    attr_accessor :versions, :base_uri, :prepend_errors
+
+    def reset
+      # set defaults
+      self.versions = {}
+      self.base_uri = ''
+      self.prepend_errors = false
+    end
+
+    def base_uri_from_opts(opts)
+      # specify a base uri:
+      #   base:'http://www.example.com/'
+      # or set a default base like:
+      #   VersionedRetry.base = 'http://www.example.com/'
+      b = opts.has_key?(:base_uri) && (opts[:override]==true || self.base_uri=='') ? opts[:base_uri] : self.base_uri
+      raise('Empty base URI! Set VersionedBlock.base_uri or pass a :base_uri as an option') if b.nil? || b==''
+      b += '/' unless b[-1]=='/' # add a slash if it's missing
+      b = b[0..-2] if b[-2..-1]=='//' # get rid of trailing double slashes
+      b
+    end
+
+    def opts_specify_a_version?(opts)
+      opts.has_key?(:to) || (opts.has_key?(:to) && opts.has_key?(:from)) || opts.has_key?(:only) || opts.has_key?(:these)
+    end
+
+    def versions_from_opts(opts)
+      # specifying versioning:
+      #   pass {only:1} to test only v1
+      #   pass {to:3} to test v1,v2,v3
+      #   pass {from:2, to:3} to test v2,v3
+      #   pass {these:[1,2,4]} to test v1,v2,v4 but NOT v3
+      # you can set default versioning with:
+      #   VersionedRetry.config = {}
+      # you can then override that default for a specifig case by passing:
+      #   override:true
+      # or reset the default versioning with:
+      #   VersionedRetry.reset
+      opts = opts_specify_a_version?(opts) || (opts[:override]==true && opts_specify_a_version?(opts)) ? opts : self.versions 
+      #opts = self.versions unless (opts[:override]==true || self.versions == {})
+      if opts[:from].is_a?(Integer) && opts[:to].is_a?(Integer) # from vX to vY
+        raise "Expected :from (#{opts[:from]}) to be less than :to (#{opts[:to]})" if opts[:from] > opts[:to]
+        versions_to_test = (opts[:from]..opts[:to])
+      else
+        if opts[:to].is_a?(Integer) # up to vX
+          versions_to_test = (1..opts[:to])
+        elsif opts[:only].is_a?(Integer) # only vX
+          versions_to_test = [opts[:only]]
+        elsif opts[:these].is_a?(Array) # vX, vY, etc. for each of :these
+          if opts[:these].all?{|n| n.is_a?(Integer)}
+            versions_to_test = opts[:these]
+          else
+            raise "Each element in :these must be an integer"
+          end
+        else
+          raise "Couldn't determine which versions to test!\nUse :only, :these, :to, or :from and :to"
+        end
+      end
+      versions_to_test
+    end
+  end
+end
+
+VersionedBlocks.reset
+
+module Kernel
+  def versioned_block(opts = {}, &block)
+    versions_to_test = VersionedBlocks.versions_from_opts(opts)
+    if block.arity == 2 # if block is asking for the uri and the version
+      base_uri = VersionedBlocks.base_uri_from_opts(opts)
+      versions = versions_to_test.map{|num| [num, "#{base_uri}v#{num}"]}
+    else # just return the version 
+      versions = versions_to_test.to_a
+    end
+    versions.each do |v, uri|
+      begin
+        block.call(v, uri)
+      rescue Exception=> e
+        e.message.prepend("When version = #{v}: ") if VersionedBlocks.prepend_errors || (opts[:override]==true && opts[:prepend_errors]==true)
+        raise e
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'rspec'
+require_relative '../lib/versioned_blocks.rb'
+
+RSpec.configure do |config|
+end

data/spec/versioned_blocks_spec.rb

@@ -0,0 +1,137 @@
+require_relative './spec_helper'
+
+describe 'Versioned Blocks' do
+  context 'before any config' do
+    it 'has empty config, base_uri' do
+      expect(VersionedBlocks.versions).to eq({})
+      expect(VersionedBlocks.base_uri).to eq ''
+    end
+
+    context 'prepend_errors' do
+      it 'is false' do
+        expect(VersionedBlocks.prepend_errors).to be false
+      end
+    end
+
+    context ':to' do
+      it 'counts up to x' do
+        count = 0
+        versioned_block(to:3) do |v|
+          count += 1
+          expect(v).to eq count
+        end
+      end
+    end
+
+    context ':to, :from' do
+      before :all do
+        @x = 5
+        @y = 8
+        @count = @x - 1
+      end
+
+      it 'counts from x to y' do
+        versioned_block(from:@x, to:@y) do |v|
+          @count += 1
+          expect(v).to eq @count
+        end
+        expect(@count).to eq @y
+      end
+
+      it 'raises an error if :from > :to' do
+        begin
+          versioned_block(from:@y, to:@x) {}
+          expect(false).to be true
+        rescue Exception=>e
+          expect(e.class.to_s).to eq 'RuntimeError'
+        end
+      end
+    end
+
+    context ':these' do
+      before :all do
+        @nums = [1,2,5]
+      end
+
+      it 'counts only the specified versions' do
+        versioned_block(these:@nums) do |v|
+          expect(@nums).to include v
+        end
+      end
+    end
+
+    context ':only' do
+      before :all do
+        @num = 3
+      end
+
+      it 'counts only the specified version' do
+        versioned_block(only:@num) do |v|
+          expect(@num).to eq v
+        end
+      end
+    end
+  end
+
+  context 'after config' do
+    before :all do
+      @versions = {to:5}
+      @base_uri = 'http://www.google.com/'
+      @prepend_errors = true
+      VersionedBlocks.versions = @versions
+      VersionedBlocks.base_uri = @base_uri
+      VersionedBlocks.prepend_errors = @prepend_errors
+    end
+
+    it 'has a specified version' do
+      expect(VersionedBlocks.versions).to eq @versions
+    end
+
+    it 'has a specified uri' do
+      expect(VersionedBlocks.base_uri).to eq @base_uri
+    end
+
+    it 'can override a default uri without specifying version' do
+      versioned_block(base_uri: 'test2.com', override: true) do |v, uri|
+          expect(uri).to include 'test2'
+      end
+    end
+
+    it 'can override a default uri and version' do
+      versioned_block(base_uri: 'test2.com', only:8, override: true) do |v, uri|
+          expect(uri).to include 'test2'
+          expect(v).to eq 8
+      end
+    end
+
+    it 'prepends errors' do
+      expect(VersionedBlocks.prepend_errors).to eq @prepend_errors
+      begin
+        versioned_block do |v|
+          v + "can't do this!"
+        end
+      rescue Exception=>e
+        expect(e.message).to include "version"
+      end
+    end
+
+    it 'can return a version and a url' do
+      versioned_block do |v, uri|
+        expect(v).to be_a Integer
+        expect(uri).to be_a String
+        expect(uri).to include @base_uri
+      end
+    end
+
+    it 'returns the default specified versions' do
+      versioned_block do |v|
+        count = 0
+        versioned_block do |v|
+          count += 1
+          expect(v).to eq count
+        end
+        expect(count).to eq @versions[:to]
+      end
+    end
+  end
+end

data/versioned_blocks.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'versioned_blocks'
+
+Gem::Specification.new do |spec|
+  spec.name          = "versioned_blocks"
+  spec.version       = VersionedBlocks::VERSION
+  spec.authors       = ["devend711@gmail.com"]
+  spec.email         = ["devend711@gmail.com"]
+  spec.summary       = "Easily loop through versioned API URIs"
+  #spec.description   = %q{TODO: Write a longer description. Optional.}
+  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.6"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: versioned_blocks
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- devend711@gmail.com
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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'
+description: 
+email:
+- devend711@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/versioned_blocks.rb
+- spec/spec_helper.rb
+- spec/versioned_blocks_spec.rb
+- versioned_blocks.gemspec
+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: Easily loop through versioned API URIs
+test_files:
+- spec/spec_helper.rb
+- spec/versioned_blocks_spec.rb