api-exporter 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ede5eb3bb7c20ed8a8f56154fd68ab9a8ab41be64db10f5a0ea6a3f2294bb5fb
+  data.tar.gz: e72bd6bf2688a14b25168ac21bb2a60cafe81869d3a7af6eb7816b7c41e710b3
+SHA512:
+  metadata.gz: e5a8e4ce1dc6a321a5768f6a74ca79d4c45b134e0ba8dbd19b7950d401e44a27d7d046e6be1de5c010320d8efa145f6291458c9fa95acd70e1939c5b864fed06
+  data.tar.gz: b42766d8ac1c372115e70419e82016822f2e8fa39af17336a6e7361de3e0c31ffa709cefdfa519f3d58a696076ba279ae4155cc1ae12a7e22965e1698cfc927b

data/.version

@@ -0,0 +1 @@
+0.2.0

data/lib/api-exporter.rb

@@ -0,0 +1,109 @@
+require 'hash_wia'
+
+class ApiExporter
+  EXPORTERS ||= {
+    __filter: proc {}
+  }
+
+  attr_accessor :response, :user, :model, :version
+
+  class << self
+    def define name, opts={}, &block
+      version = opts.delete(:version) || opts.delete(:v) || 1
+      EXPORTERS[version] ||= {}
+      EXPORTERS[version][name.to_s.classify] = block
+    end
+
+    def export name, opts={}
+      new(name, opts).render
+    end
+
+    def filter &block
+      EXPORTERS[:__filter] = block
+    end
+  end
+
+  ###
+
+  def initialize model, opts={}
+    if model.is_a?(String) || model.is_a?(Symbol)
+      raise ArgumentError, 'model argument is not model instance (it is %s)' % model.class
+    end
+
+    unless opts.is_a?(Hash)
+      raise ArgumentError, 'ApiExporter opts is not a hash'
+    end
+
+    opts[:version]       ||= opts.delete(:v) || 1
+    opts[:depth]         ||= 2 # 2 is default depth
+    opts[:current_depth] ||= 0
+    opts[:current_depth] += 1
+
+    unallowed = opts.keys - %i(user version depth current_depth exporter)
+    raise ArgumentError, 'Unallowed key ApiExporter option found: %s' % unallowed.first if unallowed.first
+
+    @model    = model
+    @version  = opts[:version]
+    @user     = opts[:user]
+    @opts     = opts
+    @block    = _find_exporter
+
+    @response = {}.to_hwia
+  end
+
+  def render
+    instance_exec &@block
+    instance_exec &EXPORTERS[:__filter]
+    @response
+  end
+
+  private
+
+  # export object
+  def export name
+    return if @opts[:current_depth] > @opts[:depth]
+
+    if name.is_a?(Symbol)
+      name, cmodel = name, @model.send(name)
+    else
+      name, cmodel = name.class.to_s.underscore.to_sym, name
+    end
+
+    @response[name] = ApiExporter.export(cmodel, @opts)
+  end
+
+  # add property to exporter
+  def property name, data=:_undefined
+    if block_given?
+      data = yield
+    elsif data == :_undefined
+      data = @model.send(name)
+    end
+
+    @response[name] = data unless data.nil?
+  end
+  alias :prop :property
+
+  # copy calls from lesser version of the same exporter
+  def copy version=nil
+    version ||= @opts[:version] - 1
+    exporter = _find_exporter version
+    instance_exec &exporter
+  end
+
+  # finds versioned exporter
+  def _find_exporter version=nil
+    version  ||= @version
+    exporter   = @opts.delete(:exporter) || model.class
+    @exporter  = exporter.to_s.classify
+
+    for num in version.downto(1).to_a
+      if block = EXPORTERS.dig(num, @exporter)
+        return block
+      end
+    end
+
+    raise('Exporter "%s" (:%s) not found' % [exporter, exporter.underscore])
+  end
+end
+

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: api-exporter
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Dino Reic
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-08-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hash_wia
+  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: API exporter that is easy to understand, extend and use.
+email: reic.dino@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- "./.version"
+- "./lib/api-exporter.rb"
+homepage: https://github.com/dux/api-exporter
+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: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Fast and intuitive api exporter
+test_files: []