skalka 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c0e0999bc447eda62f39296a95be5f86a7fa7d99950c9f5849f87cb3431ea101
+  data.tar.gz: 1a0d4e2a0d0fa1d06d754a5d969b35a07c3d2b069a5dc88fa48799a7ae8a79d4
+SHA512:
+  metadata.gz: 7271be51fee6c0e7d4d1e63bc30dab27b6f5f215ff66b67dbb822792d9feb9563c03466ad2079552c0e9881f8d9791cd53c2002662426cca6c363b4847e6543d
+  data.tar.gz: 3f0449c26566a12e463032538c77aed9d516b058f6eddbed6c7a2539a440627691c738418cb4bd3f7ffb16f595c3a27cb4e88cc138c6c3c43f97724c8c3d34c0

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,64 @@
+AllCops:
+  TargetRubyVersion: 2.5
+  DisplayCopNames: true
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/RepeatedDescription:
+  Enabled: false
+
+RSpec/MessageSpies:
+  EnforcedStyle: receive
+
+Style/AndOr:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/MethodCalledOnDoEndBlock:
+  Enabled: true
+
+Style/CollectionMethods:
+  Enabled: true
+
+Style/SymbolArray:
+  Enabled: true
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+  ConsistentQuotesInMultiline: true
+
+Style/EmptyMethod:
+  EnforcedStyle: expanded
+  SupportedStyles:
+    - compact
+    - expanded
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/StringMethods:
+  Enabled: true
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/BlockLength:
+  Enabled: false
+
+Layout/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+  SupportedStyles:
+    - with_first_parameter
+    - with_fixed_indentation
+
+Lint/EndAlignment:
+  EnforcedStyleAlignWith: variable
+  SupportedStylesAlignWith:
+    - keyword
+    - variable

data/.tool-versions

@@ -0,0 +1 @@
+ruby 2.5.0

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in skalka.gemspec
+gemspec
+
+gem "pry"

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    skalka (0.1.0)
+      transproc
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    method_source (0.9.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    transproc (1.0.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  skalka!
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Emil Shakirov
+
+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,92 @@
+# Skalka
+
+![](https://i.imgur.com/rsw7QPg.png)
+
+### Skalka — the rolling pin for your json api responses.
+
+## Installation
+
+Add to Gemfile
+
+```ruby
+gem "skalka"
+```
+Run bundle
+
+```bash
+bundle install
+```
+
+## Usage
+
+```ruby
+require "skalka"
+
+json = %{
+  {
+    "data": [{
+      "type": "articles",
+      "id": "1",
+      "attributes": {
+        "title": "Wise Thought",
+        "body": "You can't blame gravity for falling in love.",
+        "created_at": "2015-05-22T14:56:29.000Z",
+        "updated_at": "2015-05-22T14:56:28.000Z"
+      },
+      "relationships": {
+        "author": {
+          "data": { "id": "42", "type": "people" }
+        },
+        "comments": {
+          "data": { "id": "55", "type": "comments" }
+        }
+      }
+    }],
+    "included": [
+      {
+        "type": "people",
+        "id": "42",
+        "attributes": {
+          "name": "Albert Einstein",
+          "age": 76,
+          "gender": "male"
+        }
+      },
+      {
+        "type": "comments",
+        "id": "55",
+        "attributes": {
+          "content": "Meh"
+        }
+      }
+    ],
+    "meta": {
+      "page": 1,
+      "count": 1
+    }
+  }
+}
+
+Skalka.call(json)
+
+{
+  data: {
+    id: "1", title: "Wise Thought",
+    body: "You can't blame gravity for falling in love.",
+    created_at: "2015-05-22T14:56:29.000Z",
+    updated_at: "2015-05-22T14:56:28.000Z",
+    author: [{ id: "42", name: "Albert Einstein", age: 76, gender: "male" }],
+    comments: [{ id: "55", content: "Meh" }]
+  },
+    meta: { page: 1, count: 1 }
+}
+```
+
+## Ruby support
+
+- 2.5.0
+
+
+## Credits
+
+Skalka is built with [transproc](https://github.com/solnic/transproc) under the hood and shares its FP spirit.

data/Rakefile

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

data/lib/skalka/functions.rb

@@ -0,0 +1,44 @@
+require "json"
+require "transproc"
+require "transproc/conditional"
+
+module Skalka
+  module Functions
+    EXTRA_FIELDS = %i[errors links meta].freeze
+
+    extend Transproc::Registry
+
+    import Transproc::ArrayTransformations
+    import Transproc::Conditional
+    import Transproc::HashTransformations
+
+    import :parse, from: JSON, as: :parse_json
+
+    module_function
+
+    def fetch_data(item)
+      item.fetch(:data, {})
+    end
+
+    def flat_wrap(data)
+      [data].flatten
+    end
+
+    def extra_fields(parsed_json)
+      parsed_json.slice(*EXTRA_FIELDS)
+    end
+
+    def extract(parsed_json)
+      (
+        self[:fetch_data] >>
+        self[:flat_wrap] >>
+        self[:map_array, Resource[:build_resource].with(parsed_json)] >>
+        self[:unwrap]
+      ).call(parsed_json)
+    end
+
+    def unwrap(list)
+      Functions[:guard, ->(l) { l.one? }, ->(l) { l.first }][list]
+    end
+  end
+end

data/lib/skalka/resource.rb

@@ -0,0 +1,61 @@
+module Skalka
+  module Resource
+    extend Transproc::Registry
+
+    module_function
+
+    def build_resource(item, parsed_json)
+      raw_relationships = item.fetch(:relationships, {})
+      included = parsed_json.fetch(:included, [])
+
+      {
+        **self[:deattribute][item],
+        **relationships(included, raw_relationships)
+      }
+    end
+
+    def deattribute(item)
+      {
+        id: item[:id].to_i,
+        **item[:attributes]
+      }
+    end
+
+    def deattribute_with_nested(item)
+      {
+        **deattribute(item),
+        **nested_relationships(item.fetch(:relationships, {}))
+      }
+    end
+
+    def fetch_link(included)
+      Functions[:fetch_data] >>
+        Functions[:flat_wrap] >>
+        Functions[:map_array, self[:find_resource].with(included) >> self[:deattribute_with_nested]] >>
+        Functions[:unwrap]
+    end
+
+    def find_resource(relationship, included)
+      included.find do |included_resource|
+        included_resource.values_at(:id, :type) == relationship.values_at(:id, :type)
+      end
+    end
+
+    def nested_relationships(relationships)
+      Functions[
+        :map_values,
+        Functions[:fetch_data] >>
+        Functions[:flat_wrap] >>
+        Functions[
+          :map_array,
+          Functions[:accept_keys, [:id]] >>
+          Functions[:map_value, :id, ->(id) { id.to_i }]
+        ]
+      ][relationships]
+    end
+
+    def relationships(included, raw_relationships)
+      Functions[:map_values, fetch_link(included)][raw_relationships]
+    end
+  end
+end

data/lib/skalka/version.rb

@@ -0,0 +1,3 @@
+module Skalka
+  VERSION = "0.1.0".freeze
+end

data/lib/skalka.rb

@@ -0,0 +1,23 @@
+require "skalka/functions"
+require "skalka/resource"
+require "skalka/version"
+
+module Skalka
+  autoload :Functions, "skalka/functions"
+  autoload :Resource, "skalka/resource"
+
+  module_function
+
+  def call(json)
+    parsed_json = parse_json(json)
+
+    {
+      data: Functions[:extract][parsed_json],
+      **Functions[:extra_fields][parsed_json]
+    }
+  end
+
+  private def parse_json(json)
+    (Functions[:parse_json] >> Functions[:deep_symbolize_keys])[json]
+  end
+end

data/skalka.gemspec

@@ -0,0 +1,28 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "skalka/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "skalka"
+  spec.version       = Skalka::VERSION
+  spec.authors       = ["Emil Shakirov"]
+  spec.email         = ["me@emil.sh"]
+
+  spec.summary       = "The rolling pin for your json api responses."
+  spec.description   = "Simple JSON API parser/flattener"
+  spec.homepage      = "https://github.com/vaihtovirta/skalka.git"
+  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_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_dependency "transproc"
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: skalka
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Emil Shakirov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-03-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: transproc
+  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: Simple JSON API parser/flattener
+email:
+- me@emil.sh
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".tool-versions"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/skalka.rb
+- lib/skalka/functions.rb
+- lib/skalka/resource.rb
+- lib/skalka/version.rb
+- skalka.gemspec
+homepage: https://github.com/vaihtovirta/skalka.git
+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.7.6
+signing_key: 
+specification_version: 4
+summary: The rolling pin for your json api responses.
+test_files: []