shackleton 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6954e600be3d0361b3cbf63489ba32028a2e94e0
+  data.tar.gz: f13ad60fbba787ae362323881070ef1680c73152
+SHA512:
+  metadata.gz: 0c82960ddb9f2a7a17830eb424d0ad4a3cb127aba31d20ab58d4e55c694010854f57f6a878fc6922066ae50d580fc07ce0405a82df3bb8cf8338bdffdaf956ae
+  data.tar.gz: bc6cd5229faf14d91557a773f628733051f334410bce01c447570a0c185fcd9b8d29af52a35ef8f9d775de35afdfcf3f6622b73a2472c21c6b381ba60a7e5ca5

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.15.1

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 TODO: Write your name
+
+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,58 @@
+# Shackleton
+
+A URL builder DSL, set up your API routes, and then call to build your URL
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'shackleton'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install shackleton
+
+## Usage
+
+```ruby
+map = Shackleton.mapper do
+  route :line, 'line(/:id)' do
+    route :meta do
+      route :modes
+      route :severity
+      route :disruption_categories, 'disruptioncategories'
+      route :service_types, 'servicetypes'
+    end
+    route :mode, 'mode/:modes' do
+      route :route
+    end
+  end
+end
+
+map.line(id: 'northern').meta.modes.to_s #=> 'line/10/meta/modes'
+map.line(id: 'northern').mode(mode: 'tube', detail: true).to_s #=> 'line/10/meta/modes/tube?detail=true'
+map.line.meta.modes.to_s #=> 'line/meta/modes'
+```
+
+The mapper defines the structure of the urls, and when you call each fragment, your aruments are captured and then replayed to create your URL, undefined query params are supported, they're attached to the end of the URI
+
+`
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/adamcarlile/shackleton.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "shackleton"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/shackleton.rb

@@ -0,0 +1,17 @@
+require 'mustermann'
+require 'shackleton/extensions/hash_slice'
+require "shackleton/version"
+
+require 'shackleton/route'
+require 'shackleton/mapper'
+require 'shackleton/fragment'
+require 'shackleton/builder'
+
+module Shackleton
+  module_function
+
+  def mapper(&block)
+    Shackleton::Mapper.new(&block)
+  end
+  
+end

data/lib/shackleton/builder.rb

@@ -0,0 +1,30 @@
+module Shackleton
+  class Builder
+    extend Forwardable
+
+    def_delegator :build, :to_s
+
+    def stack 
+      @stack ||= []
+    end
+
+    def build
+      [stack.map(&:call).compact.join('/').gsub(%r{/+}, '/'), query_params].reject(&:empty?).join("?")
+    end
+
+    def add_route(route, kwargs)
+      stack << Shackleton::Fragment.new(route, kwargs)
+      self
+    end
+
+    def query_params
+      URI.encode_www_form(Hash[*stack.map {|x| x.query_params.to_a}.flatten])
+    end
+
+    def method_missing(method, *args, **kwargs, &block)
+      return self.add_route(stack.last[method.to_sym], kwargs) if stack.last[method.to_sym]
+      super
+    end
+
+  end
+end

data/lib/shackleton/extensions/hash_slice.rb

@@ -0,0 +1,14 @@
+module Shackleton
+  module Extensions
+    module HashSlice 
+      def slice(*keys)
+        ::Hash[[keys, self.values_at(*keys)].transpose]
+      end
+      def except(*keys)
+        desired_keys = self.keys - keys
+        ::Hash[[desired_keys, self.values_at(*desired_keys)].transpose]
+      end
+    end
+  end
+end
+Hash.include Shackleton::Extensions::HashSlice

data/lib/shackleton/fragment.rb

@@ -0,0 +1,25 @@
+module Shackleton
+  class Fragment
+    extend Forwardable
+
+    def_delegator :@route, :[]
+
+    def initialize(route, arguments)
+      @route = route
+      @arguments = arguments
+    end
+
+    def call
+      @route.expand(arguments)
+    end
+
+    def arguments
+      @arguments.slice(*@route.named_fragments)
+    end
+
+    def query_params
+      @arguments.except(*@route.named_fragments)
+    end
+
+  end
+end

data/lib/shackleton/mapper.rb

@@ -0,0 +1,14 @@
+module Shackleton
+  class Mapper
+
+    def initialize &block
+      @root = Shackleton::Route.new(&block)
+    end
+
+    def method_missing(method, *args, **kwargs, &block)
+      return Shackleton::Builder.new.add_route(@root[method.to_sym], kwargs) if @root[method.to_sym]
+      super
+    end
+
+  end
+end

data/lib/shackleton/route.rb

@@ -0,0 +1,35 @@
+module Shackleton
+  class Route
+    extend Forwardable
+
+    def_delegator :routes, :[]
+    def_delegator :pattern, :expand
+
+    def initialize(name: nil, path: nil, parent: nil, **options, &block)
+      @name     = name
+      @path     = path || name.to_s
+      @options  = options
+      @parent   = parent
+      instance_exec self, &block if block_given?
+    end
+    
+    def route(name, path=nil, **options, &block)
+      routes[name.to_sym] = self.class.new(name: name, path: path, **options, &block)
+    end
+
+    def routes
+      @routes ||= {}
+    end
+
+    def named_fragments
+      @named_fragments ||= pattern.names.map(&:to_sym)
+    end
+
+    private
+
+    def pattern
+      @pattern ||= Mustermann.new(@path, type: :rails)
+    end
+
+  end
+end

data/lib/shackleton/version.rb

@@ -0,0 +1,3 @@
+module Shackleton
+  VERSION = "0.1.0"
+end

data/shackleton.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "shackleton/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "shackleton"
+  spec.version       = Shackleton::VERSION
+  spec.authors       = ["Adam Carlile"]
+  spec.email         = ["github@adamcarlile.com"]
+
+  spec.summary       = %q{Map your way across that cold tudra of API consuming}
+  spec.homepage      = "https://github.com/adamcarlile/shackelton"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "mustermann"
+  spec.add_dependency "mustermann-contrib"
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: shackleton
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Adam Carlile
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-03-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mustermann
+  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'
+- !ruby/object:Gem::Dependency
+  name: mustermann-contrib
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: pry
+  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:
+- github@adamcarlile.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/shackleton.rb
+- lib/shackleton/builder.rb
+- lib/shackleton/extensions/hash_slice.rb
+- lib/shackleton/fragment.rb
+- lib/shackleton/mapper.rb
+- lib/shackleton/route.rb
+- lib/shackleton/version.rb
+- shackleton.gemspec
+homepage: https://github.com/adamcarlile/shackelton
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Map your way across that cold tudra of API consuming
+test_files: []