tlaw 0.0.2 → 0.1.0.pre

data/lib/tlaw/version.rb

@@ -1,7 +1,10 @@
+# frozen_string_literal: true
+
 module TLAW
   MAJOR = 0
-  MINOR = 0
-  PATCH = 2
+  MINOR = 1
+  PATCH = 0
+  PRE = 'pre'
 
-  VERSION = [MAJOR, MINOR, PATCH].join('.')
+  VERSION = [MAJOR, MINOR, PATCH, PRE].compact.join('.')
 end

data/tlaw.gemspec

@@ -3,14 +3,12 @@ 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.authors  = ['Victor Shepelev', 'Joel Van Horn']
+  s.email    = %w[zverok.offline@gmail.com joel@joelvanhorn.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.summary = 'The Last API Wrapper: Pragmatic API wrapper framework'
+  s.description = %q{TLAW is the last (and only) API wrapper framework you'll ever need for accessing GET-only APIs in a consistent way (think weather, search, economical indicators, geonames and so on).}
   s.licenses = ['MIT']
 
   s.files = `git ls-files`.split($RS).reject do |file|
@@ -24,10 +22,12 @@ Gem::Specification.new do |s|
     |\.travis.yml
     )$/x
   end
-  s.require_paths = ["lib"]
 
-  s.required_ruby_version = '>= 2.1.0'
+  s.require_paths = ['lib']
 
+  s.required_ruby_version = '>= 2.3.0'
+
+  s.add_runtime_dependency 'backports'
   s.add_runtime_dependency 'faraday'
   s.add_runtime_dependency 'faraday_middleware'
   s.add_runtime_dependency 'addressable'
@@ -38,7 +38,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rubygems-tasks'
 
   # Testing
-  s.add_development_dependency 'rubocop', '>= 0.40'
+  s.add_development_dependency 'rubocop'
   s.add_development_dependency 'rubocop-rspec'
   s.add_development_dependency 'rspec', '>= 3.5'
   s.add_development_dependency 'rspec-its', '~> 1'

metadata

@@ -1,15 +1,30 @@
 --- !ruby/object:Gem::Specification
 name: tlaw
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0.pre
 platform: ruby
 authors:
 - Victor Shepelev
+- Joel Van Horn
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-31 00:00:00.000000000 Z
+date: 2018-12-21 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: backports
+  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: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -100,14 +115,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.40'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.40'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -234,19 +249,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: "    And here would be description.\n"
-email: zverok.offline@gmail.com
+description: TLAW is the last (and only) API wrapper framework you'll ever need for
+  accessing GET-only APIs in a consistent way (think weather, search, economical indicators,
+  geonames and so on).
+email:
+- zverok.offline@gmail.com
+- joel@joelvanhorn.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".codeclimate.yml"
 - ".rubocop_todo.yml"
+- ".ruby-version"
 - ".yardopts"
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
 - examples/demo_base.rb
+- examples/experimental/README.md
+- examples/experimental/afterthedeadline.rb
+- examples/experimental/airvisual.rb
+- examples/experimental/apixu.rb
+- examples/experimental/bing_maps.rb
+- examples/experimental/currencylayer.rb
+- examples/experimental/earthquake.rb
+- examples/experimental/freegeoip.rb
+- examples/experimental/geonames.rb
+- examples/experimental/isfdb.rb
+- examples/experimental/musicbrainz.rb
+- examples/experimental/nominatim.rb
+- examples/experimental/omdb.rb
+- examples/experimental/open_exchange_rates.rb
+- examples/experimental/open_route.rb
+- examples/experimental/open_street_map.rb
+- examples/experimental/quandl.rb
+- examples/experimental/reddit.rb
+- examples/experimental/swapi.rb
+- examples/experimental/tmdb.rb
+- examples/experimental/world_bank.rb
+- examples/experimental/world_bank_climate.rb
+- examples/experimental/wunderground.rb
+- examples/experimental/wunderground_demo.rb
 - examples/forecast_io.rb
 - examples/forecast_io_demo.rb
 - examples/giphy.rb
@@ -260,12 +304,18 @@ files:
 - lib/tlaw/api_path.rb
 - lib/tlaw/data_table.rb
 - lib/tlaw/dsl.rb
+- lib/tlaw/dsl/api_builder.rb
+- lib/tlaw/dsl/base_builder.rb
+- lib/tlaw/dsl/endpoint_builder.rb
+- lib/tlaw/dsl/namespace_builder.rb
 - lib/tlaw/endpoint.rb
+- lib/tlaw/formatting.rb
+- lib/tlaw/formatting/describe.rb
+- lib/tlaw/formatting/inspect.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/response_processors.rb
 - lib/tlaw/util.rb
 - lib/tlaw/version.rb
 - tlaw.gemspec
@@ -281,16 +331,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.1.0
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
-summary: Here would be summary
+summary: 'The Last API Wrapper: Pragmatic API wrapper framework'
 test_files: []

data/lib/tlaw/param_set.rb

@@ -1,111 +0,0 @@
-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

@@ -1,126 +0,0 @@
-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.keys.grep(@key).inject(hash) do |res, k|
-          res.merge(k => @block.call(hash[k]))
-        end
-      end
-    end
-
-    class Replace < Base
-      def call(hash)
-        @block.call(hash)
-      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.is_a?(Hash)
-        hash.keys.grep(@key).inject(hash) do |res, k|
-          next res unless hash[k].is_a?(Array)
-          res.merge(k => hash[k].map(&@item_processor))
-        end
-      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