apitizer 0.0.1 → 0.0.2

data/spec/apitizer/routing/path_spec.rb

@@ -1,102 +1,22 @@
 require 'spec_helper'
 
-describe Apitizer::Routing::Path do
-  extend ResourceHelper
-  include FactoryHelper
-
-  describe '#<<' do
-    it 'builds up addresses' do
-      [ :articles, 'xxx', :sections, 'yyy' ].each { |step| subject << step }
-      expect(subject.address).to eq('articles/xxx/sections/yyy')
-    end
-  end
+RSpec.describe Apitizer::Routing::Path do
+  let(:subject_class) { Apitizer::Routing::Path }
 
   describe '#advance' do
-    it 'keeps track of destinations' do
-      nodes = [ double('articles'), double('sections') ]
-      nodes.each { |node| subject.advance(node) }
-      expect(subject.node).to be(nodes.last)
-    end
-  end
-
-  an_adequate_guard = Proc.new do |only_actions = restful_actions|
-    (restful_collection_actions & only_actions).each do |action|
-      it "is true for #{ action } collection action" do
-        path = root.trace(steps)
-        expect(path.permitted?(action)).to be_true
-      end
-    end
-
-    (restful_member_actions & only_actions).each do |action|
-      it "is true for #{ action } member actions" do
-        path = root.trace([ *steps, 'xxx' ])
-        expect(path.permitted?(action)).to be_true
-      end
-    end
-
-    (restful_collection_actions - only_actions).each do |action|
-      it "is false for #{ action } collection action" do
-        path = root.trace(steps)
-        expect(path.permitted?(action)).to be_false
-      end
-    end
-
-    (restful_member_actions - only_actions).each do |action|
-      it "is false for #{ action } member actions" do
-        path = root.trace([ *steps, 'xxx' ])
-        expect(path.permitted?(action)).to be_false
-      end
-    end
-
-    restful_member_actions.each do |action|
-      it "is false for #{ action } actions to collections" do
-        path = root.trace(steps)
-        expect(path.permitted?(action)).to be_false
-      end
-    end
-
-    restful_collection_actions.each do |action|
-      it "is false for #{ action } actions to members" do
-        path = root.trace([ *steps, 'xxx' ])
-        expect(path.permitted?(action)).to be_false
-      end
+    it 'builds up addresses' do
+      subject.advance('articles', node: double)
+      subject.advance('xxx', node: double)
+      expect(subject.address).to eq('articles/xxx')
     end
   end
 
-  describe '#permitted?' do
-    context 'when working with plain collections' do
-      let(:root) { create_tree(:articles) }
-      let(:steps) { [ :articles ] }
-
-      instance_exec(&an_adequate_guard)
-    end
-
-    context 'when working with nested collections' do
-      let(:root) { create_tree(:articles, :sections) }
-      let(:steps) { [ :articles, 'yyy', :sections ] }
-
-      instance_exec(&an_adequate_guard)
-    end
-
-    context 'when working with collections restricted to index and show' do
-      let(:root) { create_tree([ :articles, [ :index, :show ] ]) }
-      let(:steps) { [ :articles ] }
-
-      instance_exec([ :index, :show ], &an_adequate_guard)
-    end
-
-    restful_member_actions.each do |action|
-      it "is true for custom #{ action } operations on members" do
-        root = create_tree(:articles, shred: action)
-        path = root.trace([ :articles, 'xxx', :shred ])
-        expect(path.permitted?(action)).to be_true
-      end
-
-      it "is true for custom #{ action } operations with variable names" do
-        root = create_tree(:articles, ':paragraph' => action)
-        path = root.trace([ :articles, 'xxx', 'zzz' ])
-        expect(path.permitted?(action)).to be_true
-      end
+  describe '#clone' do
+    it 'properly does its job' do
+      subject.advance('articles', node: double)
+      another = subject.clone
+      another.advance('xxx', node: double)
+      expect(subject.address).to eq('articles')
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,11 +1,9 @@
-require 'support/resource_helper'
-require 'support/factory_helper'
 require 'webmock/rspec'
 require 'apitizer'
 
+require 'support/resource_helper'
+require 'support/factory_helper'
+
 RSpec.configure do |config|
-  config.treat_symbols_as_metadata_keys_with_true_values = true
-  config.run_all_when_everything_filtered = true
-  config.filter_run :focus
-  config.order = 'random'
+  config.disable_monkey_patching!
 end

data/spec/support/factory_helper.rb

@@ -1,23 +1,43 @@
 module FactoryHelper
+  include ResourceHelper
+
   def create_tree(*names)
     operations = names.last.is_a?(Hash) ? names.pop : {}
-    root = Apitizer::Routing::Node::Root.new
+
+    root = build_root
+
     leaf = names.inject(root) do |parent, object|
       if object.is_a?(Array)
         name, only = *object
-        node = Apitizer::Routing::Node::Collection.new(name, only: only)
+        node = build_collection(name, only: only)
       else
         name = object
-        node = Apitizer::Routing::Node::Collection.new(name)
+        node = build_collection(name)
       end
       parent.append(node)
       node
     end
+
     operations.each do |name, action|
-      operation = Apitizer::Routing::Node::Operation.new(
-        name, action: action, on: :member)
+      on = restful_member_actions.include?(action) ? :member : :collection
+      operation = build_operation(name, action: action, on: on)
       leaf.append(operation)
     end
+
     root
   end
+
+  private
+
+  def build_root(*arguments)
+    Apitizer::Routing::Node::Root.new(*arguments)
+  end
+
+  def build_collection(*arguments)
+    Apitizer::Routing::Node::Collection.new(*arguments)
+  end
+
+  def build_operation(*arguments)
+    Apitizer::Routing::Node::Operation.new(*arguments)
+  end
 end

data/spec/support/resource_helper.rb

@@ -15,4 +15,12 @@ module ResourceHelper
     { :index => :get, :show => :get, :create => :post,
       :update => :put, :delete => :delete }
   end
+
+  def http_methods
+    [ :get, :post, :put, :patch, :delete ]
+  end
+
+  def mime_type_dictionary
+    { :json => 'application/json', :yaml => 'application/x-yaml' }
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apitizer
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Ivan Ukhov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-01 00:00:00.000000000 Z
+date: 2014-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -118,6 +118,8 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".travis.yml"
+- ".yardopts"
 - CHANGELOG.md
 - Gemfile
 - Guardfile
@@ -131,34 +133,31 @@ files:
 - lib/apitizer/connection/adaptor.rb
 - lib/apitizer/connection/adaptor/standard.rb
 - lib/apitizer/connection/dispatcher.rb
+- lib/apitizer/connection/format.rb
+- lib/apitizer/connection/format/json.rb
+- lib/apitizer/connection/format/yaml.rb
 - lib/apitizer/connection/request.rb
 - lib/apitizer/connection/response.rb
 - lib/apitizer/core.rb
 - lib/apitizer/helper.rb
-- lib/apitizer/processing.rb
-- lib/apitizer/processing/parser.rb
-- lib/apitizer/processing/parser/json.rb
-- lib/apitizer/processing/parser/yaml.rb
-- lib/apitizer/processing/translator.rb
 - lib/apitizer/result.rb
 - lib/apitizer/routing.rb
-- lib/apitizer/routing/mapper.rb
+- lib/apitizer/routing/map.rb
 - lib/apitizer/routing/node.rb
 - lib/apitizer/routing/node/base.rb
 - lib/apitizer/routing/node/collection.rb
 - lib/apitizer/routing/node/operation.rb
 - lib/apitizer/routing/node/root.rb
-- lib/apitizer/routing/node/scope.rb
 - lib/apitizer/routing/path.rb
 - lib/apitizer/routing/proxy.rb
 - lib/apitizer/version.rb
 - spec/apitizer/base_spec.rb
 - spec/apitizer/connection/adaptor_spec.rb
 - spec/apitizer/connection/dispatcher_spec.rb
+- spec/apitizer/connection/format_spec.rb
 - spec/apitizer/helper_spec.rb
-- spec/apitizer/processing/parser_spec.rb
 - spec/apitizer/result_spec.rb
-- spec/apitizer/routing/mapper_spec.rb
+- spec/apitizer/routing/map_spec.rb
 - spec/apitizer/routing/node_spec.rb
 - spec/apitizer/routing/path_spec.rb
 - spec/spec_helper.rb
@@ -192,10 +191,10 @@ test_files:
 - spec/apitizer/base_spec.rb
 - spec/apitizer/connection/adaptor_spec.rb
 - spec/apitizer/connection/dispatcher_spec.rb
+- spec/apitizer/connection/format_spec.rb
 - spec/apitizer/helper_spec.rb
-- spec/apitizer/processing/parser_spec.rb
 - spec/apitizer/result_spec.rb
-- spec/apitizer/routing/mapper_spec.rb
+- spec/apitizer/routing/map_spec.rb
 - spec/apitizer/routing/node_spec.rb
 - spec/apitizer/routing/path_spec.rb
 - spec/spec_helper.rb

data/lib/apitizer/processing.rb

@@ -1,8 +0,0 @@
-require_relative 'processing/parser'
-require_relative 'processing/translator'
-
-module Apitizer
-  module Processing
-    Error = Class.new(Apitizer::Error)
-  end
-end

data/lib/apitizer/processing/parser.rb

@@ -1,14 +0,0 @@
-require_relative 'parser/json'
-require_relative 'parser/yaml'
-
-module Apitizer
-  module Processing
-    module Parser
-      def self.build(format)
-        self.const_get(format.to_s.upcase).new
-      rescue NameError
-        raise Error, 'Unknown format'
-      end
-    end
-  end
-end

data/lib/apitizer/processing/translator.rb

@@ -1,13 +0,0 @@
-module Apitizer
-  module Processing
-    class Translator
-      def initialize(format:)
-        @parser = Parser.build(format)
-      end
-
-      def process(response)
-        @parser.process(response.body)
-      end
-    end
-  end
-end

data/lib/apitizer/routing/node/scope.rb

@@ -1,19 +0,0 @@
-module Apitizer
-  module Routing
-    module Node
-      class Scope < Base
-        def initialize(steps)
-          @steps = Array(steps)
-        end
-
-        def match(name)
-          not lookup(name).nil?
-        end
-
-        def process(path, steps)
-          @steps.each { |step| path << step }
-        end
-      end
-    end
-  end
-end

data/spec/apitizer/processing/parser_spec.rb

@@ -1,23 +0,0 @@
-require 'spec_helper'
-
-describe Apitizer::Processing::Parser do
-  let(:parent_module) { Apitizer::Processing }
-  let(:subject_class) { parent_module::Parser }
-
-  it 'supports JSON' do
-    subject = subject_class.build(:json)
-    result = subject.process('{ "articles": [] }')
-    expect(result).to eq("articles" => [])
-  end
-
-  it 'supports YAML' do
-    subject = subject_class.build(:yaml)
-    result = subject.process("---\narticles: []")
-    expect(result).to eq("articles" => [])
-  end
-
-  it 'does not support XML' do
-    expect { subject_class.build(:xml) }.to \
-      raise_error(parent_module::Error, /Unknown format/i)
-  end
-end

data/spec/apitizer/routing/mapper_spec.rb

@@ -1,80 +0,0 @@
-require 'spec_helper'
-
-describe Apitizer::Routing::Mapper do
-  extend ResourceHelper
-
-  let(:subject_class) { Apitizer::Routing::Mapper }
-
-  def create_path
-    double(:<< => nil, :advance => nil, :permitted? => true)
-  end
-
-  def expect_steps(steps, path = create_path)
-    Array(steps).each do |step|
-      expect(path).to receive(:<<).once.ordered.with(step)
-    end
-    path
-  end
-
-  def expect_trace(mapper, steps, scope = [])
-    mapper.trace(:arbitrary, steps, expect_steps(scope + steps))
-  end
-
-  describe '#define' do
-    it 'declares the root address' do
-      subject.define do
-        address('https://service.com/api')
-        resources(:articles)
-      end
-      expect_trace(subject, [ :articles, 'xxx' ], [ 'https://service.com/api' ])
-    end
-
-    it 'declares plain resources' do
-      subject.define { resources(:articles) }
-      expect_trace(subject, [ :articles ])
-    end
-
-    it 'declares nested resources' do
-      subject.define { resources(:articles) { resources(:sections) } }
-      expect_trace(subject, [ :articles, 'xxx', :sections, 'yyy' ])
-    end
-
-    it 'declares scoped resources' do
-      subject.define do
-        scope 'https://service.com/api' do
-          scope [ 'v1', :json ] do
-            resources(:articles) { resources(:sections) }
-          end
-        end
-      end
-      expect_trace(subject, [ :articles, 'xxx', :sections, 'yyy' ],
-       [ 'https://service.com/api', 'v1', :json ])
-    end
-
-    restful_member_actions.each do |action|
-      it "declares custom #{ action } operations on members" do
-        subject.define do
-          resources(:articles) { send(action, :shred, on: :member) }
-        end
-        expect_trace(subject, [ :articles, 'xxx', :shred ])
-      end
-
-      it 'declares custom operations with variable names' do
-        subject.define do
-          resources(:articles) { send(action, ':paragraph', on: :member) }
-        end
-        expect_trace(subject, [ :articles, 'xxx', 'zzz' ])
-      end
-    end
-
-    it 'does not support reopening of resource declarations' do
-      subject.define do
-        resources(:articles)
-        resources(:articles) { resources(:sections) }
-      end
-      expect do
-        subject.trace(:arbitrary, [ :articles, 'xxx', :sections, 'yyy' ])
-      end.to raise_error(Apitizer::Routing::Error, /Not found/i)
-    end
-  end
-end