apitools-middleware 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a448dab79ade7a009e9a651c20b3cd91092adc7e
+  data.tar.gz: b669baa0693438142740bf6120a87005ef9ec411
+SHA512:
+  metadata.gz: 5d7d3d4db1c0c63da26f5d6025caa065501bcf62255d3fd88546b30de4d5872167742e6e17f5e2af2b18c3046d580c0541f292c5b6033e2f0c264e064190590b
+  data.tar.gz: 8becb7e16e33500c920cec7b4ebcee83bc9bd02b98a4f91821a20404f18070da51e9f09bc6a373577eca8acbbe3487f6031b7a3fa44bfc7a7fe29c66cefec3ed

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/.rspec

@@ -0,0 +1,3 @@
+--color
+--warnings
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+- 2.1.2
+- 2.0.0
+- 1.9.3

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Michal Cichra
+
+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,35 @@
+# Apitools::Middleware [![Build Status](https://travis-ci.org/APItools/apitools-middleware.svg?branch=master)](https://travis-ci.org/APItools/apitools-middleware)
+
+Ruby Library for working with APItools Middleware. Validating, testing, ...
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'apitools-middleware'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install apitools-middleware
+
+## Usage
+
+```ruby
+repository = Apitools::Middleware::LocalRepository.new
+repository.middleware.each do |middleware|
+  puts "Middleware #{middleware.name} is invalid" unless middleware.valid?
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/APItools/apitools-middleware/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/apitools-middleware.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'apitools/middleware/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "apitools-middleware"
+  spec.version       = Apitools::Middleware::VERSION
+  spec.authors       = ["Michal Cichra"]
+  spec.email         = ["michal@3scale.net"]
+  spec.summary       = %q{Ruby Libary for Apitools Middleware}
+  spec.description   = %q{Apitools Middleware manifest, repository, specification and more.}
+  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"
+
+  spec.add_development_dependency 'rspec', '~> 3.0.0'
+
+  spec.add_dependency 'semantic'
+end

data/lib/apitools/middleware/local_repository.rb

@@ -0,0 +1,22 @@
+require 'pathname'
+
+module Apitools
+  module Middleware
+    class LocalRepository < Repository
+      PATTERN = "*/#{Spec::MANIFEST_FILE}"
+
+      def initialize(path = Pathname.pwd.join('middleware'), pattern = PATTERN)
+        @path = Pathname(path).expand_path
+        @manifests = Pathname.glob(@path.join(pattern))
+      end
+
+      def content(file)
+        Pathname(file).read
+      end
+
+      def middleware
+        @middleware ||= @manifests.map{ |manifest| Apitools::Middleware::Spec.new(self, manifest) }
+      end
+    end
+  end
+end

data/lib/apitools/middleware/manifest.rb

@@ -0,0 +1,34 @@
+require 'ostruct'
+require 'json'
+require 'forwardable'
+
+module Apitools
+  module Middleware
+    class Manifest < OpenStruct
+
+      extend Forwardable
+      def_delegator :to_h, :empty?
+
+      def self.parse(json)
+        parsed = JSON.parse(json)
+        new(parsed)
+
+      rescue JSON::ParserError
+        invalid_manifest
+      end
+
+      def self.invalid_manifest
+        # TODO: create own class for invalid manifest
+        new()
+      end
+
+      def ==(other)
+        super or to_h == other
+      end
+
+      def valid?
+        ! empty?
+      end
+    end
+  end
+end

data/lib/apitools/middleware/repository.rb

@@ -0,0 +1,15 @@
+module Apitools
+  module Middleware
+    class Repository
+      attr_accessor :middleware
+
+      def content(path)
+        raise 'needs to be reimplemented in subclasses'
+      end
+
+      def valid?
+        Array(middleware).all?(&:valid?)
+      end
+    end
+  end
+end

data/lib/apitools/middleware/spec.rb

@@ -0,0 +1,63 @@
+require 'pathname'
+require 'semantic'
+require 'forwardable'
+
+module Apitools
+  module Middleware
+    class Spec
+      MANIFEST_FILE = 'apitools.json' # should be apitools.json
+
+      attr_reader :repo, :path, :manifest_path
+
+      extend Forwardable
+      def_delegators :manifest, :name, :description, :author, :endpoints, :files
+
+      def initialize(repo, path)
+        @repo = repo
+        pathname = Pathname(path)
+        @path = pathname.dirname
+        @manifest_path = pathname.basename || MANIFEST_FILE
+      end
+
+      def manifest=(json)
+        @manifest = Manifest.parse(json)
+      end
+
+      def manifest
+        @manifest ||= Manifest.parse(load_manifest)
+      end
+
+      def code
+        @code ||= load_code
+      end
+
+      def endpoint
+        Array(endpoints).first
+      end
+
+      def version
+        Semantic::Version.new(manifest.version)
+      rescue ArgumentError
+        false
+      end
+
+      def valid?
+        required_attributes = [name, path, author, endpoint, version, description]
+        required_attributes.all?
+      end
+
+      protected
+
+      def load_manifest
+        @repo.content(@path.join(@manifest_path))
+      end
+
+      def load_code
+        file = files.first
+
+        @repo.content(@path.join(file))
+      end
+
+    end
+  end
+end

data/lib/apitools/middleware/version.rb

@@ -0,0 +1,5 @@
+module Apitools
+  module Middleware
+    VERSION = "0.0.1"
+  end
+end

data/lib/apitools/middleware.rb

@@ -0,0 +1,10 @@
+require 'apitools/middleware/version'
+
+module Apitools
+  module Middleware
+    autoload :Repository, 'apitools/middleware/repository'
+    autoload :LocalRepository, 'apitools/middleware/local_repository'
+    autoload :Spec, 'apitools/middleware/spec'
+    autoload :Manifest, 'apitools/middleware/manifest'
+  end
+end

data/lib/apitools-middleware.rb

@@ -0,0 +1 @@
+require 'apitools/middleware'

data/spec/fixtures/middleware/cache/apitools.json

@@ -0,0 +1,3 @@
+{
+    "name" : "cache middleware"
+}

data/spec/local_repository_spec.rb

@@ -0,0 +1,36 @@
+describe Apitools::Middleware::LocalRepository do
+
+  subject(:repository) { described_class.new('spec/fixtures/middleware') }
+  let(:middleware) { repository.middleware }
+
+  it 'has 3 middlewares' do
+    expect(middleware.length).to eq(3)
+  end
+
+  context 'all middlewares are valid' do
+    before do
+      middleware.each {|m| expect(m).to receive(:valid?).and_return(true) }
+    end
+    expect_it { to be_valid }
+  end
+
+  context 'some middleware is invalid' do
+    expect_it { to_not be_valid }
+  end
+
+  context 'first middleware' do
+    let(:first) { subject.middleware.first }
+
+    it 'reads the manifest' do
+      expect(first.manifest).to be_valid
+    end
+  end
+
+  context 'second middleware' do
+    let(:second) { subject.middleware[1] }
+
+    it 'does not crash' do
+      expect(second.manifest).not_to be_valid
+    end
+  end
+end

data/spec/manifest_spec.rb

@@ -0,0 +1,17 @@
+describe Apitools::Middleware::Manifest do
+
+  context 'invalid manifest' do
+    subject(:invalid_manifest) { described_class.invalid_manifest }
+    expect_it { to_not be_valid }
+  end
+
+  context 'empty manifest' do
+    subject(:empty_manifest) { described_class.new }
+    expect_it { to_not be_valid }
+  end
+
+  context 'manifest with something' do
+    subject(:manifest) { described_class.new(value: true) }
+    expect_it { to be_valid }
+  end
+end

data/spec/repository_spec.rb

@@ -0,0 +1,7 @@
+describe Apitools::Middleware::Repository do
+
+  it 'has #content method' do
+    expect{ subject.content('path') }.to raise_error(/needs to be reimplemented/)
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,84 @@
+require 'apitools/middleware'
+
+# 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, make a
+# separate helper file that requires this one and then use it only in the specs
+# 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|
+  # 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
+
+  # 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
+
+  # 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|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+    expectations.syntax = :expect
+  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|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+    mocks.syntax = :expect
+
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended.
+    mocks.verify_partial_doubles = true
+  end
+
+  config.alias_example_to :expect_it
+end
+
+RSpec::Core::MemoizedHelpers.module_eval do
+  alias to should
+  alias to_not should_not
+  alias expect_it should # keep rubymine happy
+end

data/spec/spec_spec.rb

@@ -0,0 +1,46 @@
+describe Apitools::Middleware::Spec do
+  let(:repo) { double('repository') }
+  let(:path) { Pathname('some/path.json') }
+
+  subject(:spec) { described_class.new(repo, path.to_s) }
+
+  it 'trims path to just folder' do
+    expect(spec.path).to eq(path.dirname)
+  end
+
+  it 'remembers manifest from path' do
+    expect(spec.manifest_path).to eq(path.basename)
+  end
+
+  it 'allows setting manifest as json' do
+    spec.manifest = '{ "name": "manifest" }'
+    expect(spec.manifest).to eq(name: 'manifest')
+  end
+
+  context 'with valid manifest' do
+    let(:manifest) do
+      {
+          name: 'middleware',
+          author: '3scale',
+          description: 'some description',
+          version: '1.2.3-rc.2',
+          endpoints: ['*'],
+          files: ['middleware.lua']
+      }
+    end
+
+    before do
+      spec.manifest = manifest.to_json
+    end
+
+    expect_it { to be_valid }
+  end
+
+  context 'with empty manifest' do
+    before do
+      spec.manifest = {}.to_json
+    end
+
+    expect_it { to_not be_valid }
+  end
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: apitools-middleware
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Michal Cichra
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-28 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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: semantic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Apitools Middleware manifest, repository, specification and more.
+email:
+- michal@3scale.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- apitools-middleware.gemspec
+- lib/apitools-middleware.rb
+- lib/apitools/middleware.rb
+- lib/apitools/middleware/local_repository.rb
+- lib/apitools/middleware/manifest.rb
+- lib/apitools/middleware/repository.rb
+- lib/apitools/middleware/spec.rb
+- lib/apitools/middleware/version.rb
+- spec/fixtures/middleware/cache/apitools.json
+- spec/fixtures/middleware/privacy/apitools.json
+- spec/fixtures/middleware/test/apitools.json
+- spec/local_repository_spec.rb
+- spec/manifest_spec.rb
+- spec/repository_spec.rb
+- spec/spec_helper.rb
+- spec/spec_spec.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: Ruby Libary for Apitools Middleware
+test_files:
+- spec/fixtures/middleware/cache/apitools.json
+- spec/fixtures/middleware/privacy/apitools.json
+- spec/fixtures/middleware/test/apitools.json
+- spec/local_repository_spec.rb
+- spec/manifest_spec.rb
+- spec/repository_spec.rb
+- spec/spec_helper.rb
+- spec/spec_spec.rb
+has_rdoc: