tlaw 0.0.1

data/lib/tlaw/param_set.rb

@@ -0,0 +1,111 @@
+module TLAW
+  # Represents set of param current API endpoint or namespace have.
+  # You'll never instantiate it directly, just look at {DSL#param} for
+  # param creation. But probably you could make use of knowledge of this
+  # class' API when deep investigating what's going on, like:
+  #
+  # ```ruby
+  # params = api.namespaces[:my_namespace].endpoints[:my_endpoint].param_set
+  # p [params.count, params.names, params.describe]
+  # ```
+  class ParamSet
+    attr_accessor :parent
+
+    def initialize
+      @params = {}
+    end
+
+    def add(name, **opts)
+      # Not updating parent param, just make sure it exists
+      return if @parent && @parent.all_params[name]
+
+      @params[name] =
+        if @params[name]
+          @params[name].merge(**opts)
+        else
+          Param.make(name, **opts)
+        end
+    end
+
+    def [](name)
+      @params[name]
+    end
+
+    def to_a
+      @params.values
+    end
+
+    def to_h
+      @params
+    end
+
+    def names
+      @params.keys
+    end
+
+    def empty?
+      @params.empty? && (!@parent || @parent.empty?)
+    end
+
+    def to_code
+      ordered.map(&:to_code).join(', ')
+    end
+
+    def to_hash_code(values = nil)
+      if values
+        names.map { |n| "#{n}: #{values[n].inspect}" }.join(', ')
+      else
+        names.map { |n| "#{n}: #{n}" }.join(', ')
+      end
+    end
+
+    def describe
+      Util::Description.new(ordered.map(&:describe).join("\n"))
+    end
+
+    def process(**input)
+      validate_unknown(input)
+
+      all_params
+        .map { |name, dfn| [name, dfn, input[name]] }
+        .tap(&method(:validate_required))
+        .reject { |*, val| val.nil? }
+        .map { |_name, dfn, val| [dfn.field, dfn.convert_and_format(val)] }
+        .to_h
+    end
+
+    def all_params
+      (@parent ? @parent.all_params : {}).merge(@params)
+    end
+
+    def inspect
+      "#<#{self.class.name} #{names.join(', ')}"\
+        "#{" (parent=#{parent.inspect})" if parent && !parent.empty?}>"
+    end
+
+    alias_method :to_s, :inspect
+
+    private
+
+    def validate_unknown(input)
+      (input.keys - all_params.keys).tap { |unknown|
+        unknown.empty? or
+          fail(ArgumentError, "Unknown parameters: #{unknown.join(', ')}")
+      }
+    end
+
+    def validate_required(definitions_and_params)
+      definitions_and_params.each do |name, dfn, val|
+        dfn.required? && val.nil? and
+          fail ArgumentError, "Required parameter #{name} is missing"
+      end
+    end
+
+    def ordered
+      @params.values
+             .partition(&:keyword?).reverse.map { |args|
+               args.partition(&:required?)
+             }.flatten
+    end
+  end
+end

data/lib/tlaw/response_processor.rb

@@ -0,0 +1,124 @@
+module TLAW
+  # @private
+  # FIXME: everything is awfully dirty here
+  class ResponseProcessor
+    class Base
+      def initialize(&block)
+        @block = block
+      end
+
+      def call(hash)
+        hash.tap(&@block)
+      end
+
+      def to_proc
+        method(:call).to_proc
+      end
+    end
+
+    class Key < Base
+      def initialize(key, &block)
+        @key = key
+        super(&block)
+      end
+
+      def call(hash)
+        return hash unless hash.is_a?(Hash) && hash.key?(@key)
+
+        hash.merge(@key => @block.call(hash[@key]))
+      end
+    end
+
+    class Replace < Base
+      def call(hash)
+        hash.derp(&@block)
+      end
+    end
+
+    class Items < Base
+      def initialize(key, subkey = nil, &block)
+        @key = key
+        @item_processor = subkey ? Key.new(subkey, &block) : Base.new(&block)
+      end
+
+      def call(hash)
+        return hash unless hash.key?(@key)
+        return hash unless hash[@key].is_a?(Array)
+
+        hash.merge(@key => hash[@key].map(&@item_processor))
+      end
+    end
+
+    attr_reader :post_processors
+    attr_accessor :parent
+
+    def initialize(post_processors = [])
+      @post_processors = post_processors
+    end
+
+    def add_post_processor(key = nil, &block)
+      @post_processors << (key ? Key.new(key, &block) : Base.new(&block))
+    end
+
+    def add_replacer(&block)
+      @post_processors << Replace.new(&block)
+    end
+
+    def add_item_post_processor(key, subkey = nil, &block)
+      @post_processors << Items.new(key, subkey, &block)
+    end
+
+    def process(hash)
+      flatten(hash).derp(&method(:post_process)).derp(&method(:datablize))
+    end
+
+    def all_post_processors
+      [*(parent ? parent.all_post_processors : nil), *@post_processors]
+    end
+
+    private
+
+    def flatten(value)
+      case value
+      when Hash
+        flatten_hash(value)
+      when Array
+        value.map(&method(:flatten))
+      else
+        value
+      end
+    end
+
+    def flatten_hash(hash)
+      hash.flat_map { |k, v|
+        v = flatten(v)
+        if v.is_a?(Hash)
+          v.map { |k1, v1| ["#{k}.#{k1}", v1] }
+        else
+          [[k, v]]
+        end
+      }.reject { |_, v| v.nil? }.to_h
+    end
+
+    def post_process(hash)
+      all_post_processors.inject(hash) { |res, processor|
+        processor.call(res).derp(&method(:flatten))
+      }
+    end
+
+    def datablize(value)
+      case value
+      when Hash
+        value.map { |k, v| [k, datablize(v)] }.to_h
+      when Array
+        if !value.empty? && value.all? { |el| el.is_a?(Hash) }
+          DataTable.new(value)
+        else
+          value
+        end
+      else
+        value
+      end
+    end
+  end
+end

data/lib/tlaw/util.rb

@@ -0,0 +1,45 @@
+module TLAW
+  module Util
+    module_function
+
+    def camelize(string)
+      string
+        .sub(/^[a-z\d]*/, &:capitalize)
+        .gsub(%r{(?:_|(/))([a-z\d]*)}i) {
+          "#{$1}#{$2.capitalize}" # rubocop:disable Style/PerlBackrefs
+        }
+    end
+
+    # Description is just a String subclass with rewritten `inspect`
+    # implementation (useful in `irb`/`pry`):
+    #
+    # ```ruby
+    # str = "Description of endpoint:\nIt has params:..."
+    # # "Description of endpoint:\nIt has params:..."
+    #
+    # TLAW::Util::Description.new(str)
+    # # Description of endpoint:
+    # # It has params:...
+    # ```
+    #
+    # TLAW uses it when responds to {APIPath.describe}.
+    #
+    class Description < String
+      alias_method :inspect, :to_s
+
+      def initialize(str)
+        super(str.to_s.gsub(/ +\n/, "\n"))
+      end
+
+      # @private
+      def indent(indentation = '  ')
+        gsub(/(\A|\n)/, '\1' + indentation)
+      end
+
+      # @private
+      def +(other)
+        self.class.new(super)
+      end
+    end
+  end
+end

data/lib/tlaw/version.rb

@@ -0,0 +1,7 @@
+module TLAW
+  MAJOR = 0
+  MINOR = 0
+  PATCH = 1
+
+  VERSION = [MAJOR, MINOR, PATCH].join('.')
+end

data/tlaw.gemspec

@@ -0,0 +1,53 @@
+require './lib/tlaw/version'
+
+Gem::Specification.new do |s|
+  s.name     = 'tlaw'
+  s.version  = TLAW::VERSION
+  s.authors  = ['Victor Shepelev']
+  s.email    = 'zverok.offline@gmail.com'
+  s.homepage = 'https://github.com/molybdenum-99/tlaw'
+
+  s.summary = 'Here would be summary'
+  s.description = <<-EOF
+    And here would be description.
+  EOF
+  s.licenses = ['MIT']
+
+  s.files = `git ls-files`.split($RS).reject do |file|
+    file =~ /^(?:
+    spec\/.*
+    |Gemfile
+    |Rakefile
+    |\.rspec
+    |\.gitignore
+    |\.rubocop.yml
+    |\.travis.yml
+    )$/x
+  end
+  s.require_paths = ["lib"]
+
+  s.required_ruby_version = '>= 2.1.0'
+
+  s.add_runtime_dependency 'faraday'
+  s.add_runtime_dependency 'addressable'
+  s.add_runtime_dependency 'crack'
+
+  # Managing everything
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rubygems-tasks'
+
+  # Testing
+  s.add_development_dependency 'rubocop', '>= 0.40'
+  s.add_development_dependency 'rspec', '>= 3.5'
+  s.add_development_dependency 'rspec-its', '~> 1'
+  s.add_development_dependency 'simplecov', '~> 0.9'
+  s.add_development_dependency 'faker', '>= 1.5'
+  s.add_development_dependency 'webmock', '>= 2.1'
+
+  # Documenting
+  s.add_development_dependency 'yard', '>= 0.9.5'
+
+  # Used in examples/
+  s.add_development_dependency 'dotenv'
+  s.add_development_dependency 'geo_coord'
+end

metadata

@@ -0,0 +1,265 @@
+--- !ruby/object:Gem::Specification
+name: tlaw
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Victor Shepelev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-09-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  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: addressable
+  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: crack
+  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: 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: rubygems-tasks
+  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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.40'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.40'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.5
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  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: geo_coord
+  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: |2
+      And here would be description.
+email: zverok.offline@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeclimate.yml"
+- ".yardopts"
+- LICENSE.txt
+- README.md
+- examples/demo_base.rb
+- examples/forecast_io.rb
+- examples/forecast_io_demo.rb
+- examples/open_weather_map.rb
+- examples/open_weather_map_demo.rb
+- examples/tmdb_demo.rb
+- examples/urbandictionary_demo.rb
+- lib/tlaw.rb
+- lib/tlaw/api.rb
+- lib/tlaw/api_path.rb
+- lib/tlaw/data_table.rb
+- lib/tlaw/dsl.rb
+- lib/tlaw/endpoint.rb
+- lib/tlaw/namespace.rb
+- lib/tlaw/param.rb
+- lib/tlaw/param/type.rb
+- lib/tlaw/param_set.rb
+- lib/tlaw/response_processor.rb
+- lib/tlaw/util.rb
+- lib/tlaw/version.rb
+- tlaw.gemspec
+homepage: https://github.com/molybdenum-99/tlaw
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Here would be summary
+test_files: []