jsonapi-store 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cc5abb5c77828e875fe51e220bf70c5326d5a9ce
+  data.tar.gz: 5d9e914fe4f045585efcc0988a367aa68c4ea63a
+SHA512:
+  metadata.gz: ee1faed02f071181bd66aba29057c964a31ac09bc59761680863017e3a417be0875da8926cfd9f3c04923e27155a0ccbbce935a74b5fa581456f689a319d4f0b
+  data.tar.gz: 4ad5fbc58581f5057047f16187c04791706f8d106042076ddc6cc3c784277b44551e0c1072cb7e85cdbdb8f4cdb676099d6b27654e81d79f6adc724ced9ad43d

data/.gitignore

@@ -0,0 +1,13 @@
+.ruby-version
+/.bundle/
+/Gemfile.lock
+/pkg/
+
+/.yardoc
+/_yardoc/
+/doc/
+
+/spec/reports/
+/coverage/
+
+/tmp/

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,7 @@
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+Style/FileName:
+  Exclude:
+    - 'lib/jsonapi-store.rb'

data/.simplecov

@@ -0,0 +1,6 @@
+SimpleCov.start do
+  add_filter '/bin/'
+  add_filter '/spec/'
+end
+require 'codeclimate-test-reporter'
+CodeClimate::TestReporter.start

data/.travis.yml

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

data/.yardopts

@@ -0,0 +1,5 @@
+--title 'jsonapi-store: JSON API Data Store'
+--markup markdown
+lib/**/*.rb
+-
+README.md

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at alex@semyonov.us. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in jsonapi-store.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+© Alex Semyonov, 2016
+
+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,44 @@
+# jsonapi-store: JSON API Data Store
+
+Data Store for implementing JSON API-compliant server in Ruby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jsonapi-store'
+```
+
+And then execute:
+
+```bash
+bundle
+```
+
+Or install it yourself as:
+
+```bash
+gem install jsonapi-store
+```
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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 `bin/rake install`. To release a new version, update the version number in `version.rb`, and then run `bin/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/alsemyonov/jsonapi-store. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+© [Alex Semyonov](https://github.com/alsemyonov), <[alex@semyonov.us](mailto:alex@semyonov.us?subject=jsonapi-store)> 2016.
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new(:cop)
+task default: :cop
+
+require 'yard'
+require 'yard/rake/yardoc_task'
+YARD::Rake::YardocTask.new(:doc)
+task default: :doc

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'jsonapi/store'
+
+# 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 'irb'
+IRB.start

data/bin/rake

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+                                           Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rake', 'rake')

data/bin/rspec

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+                                           Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'rspec')

data/bin/rubocop

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+                                           Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rubocop', 'rubocop')

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/jsonapi-store.gemspec

@@ -0,0 +1,39 @@
+# coding: utf-8
+# frozen_string_literal: true
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jsonapi/store/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'jsonapi-store'
+  spec.version = JSONAPI::Store::VERSION
+  spec.authors = ['Alex Semyonov']
+  spec.email = ['alex@semyonov.us']
+
+  spec.summary = 'JSON API Data Store'
+  spec.description = <<-DESCRIPTION
+Data Store for implementing JSON API-compliant server in Ruby.
+  DESCRIPTION
+  spec.homepage = 'https://github.com/alsemyonov/jsonapi-store'
+  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_runtime_dependency 'dry-types', '~> 0.9.0'
+  spec.add_runtime_dependency 'dry-struct', '~> 0.1.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'simplecov', '~> 0.12.0'
+  spec.add_development_dependency 'simplecov-html', '~> 0.10.0'
+  spec.add_development_dependency 'codeclimate-test-reporter'
+  spec.add_development_dependency 'rubocop', '~> 0.43.0'
+  spec.add_development_dependency 'yard', '~> 0.9.5'
+  spec.add_development_dependency 'redcarpet', '~> 3.3.4'
+end

data/lib/jsonapi-store.rb

@@ -0,0 +1,2 @@
+# frozen_string_literal: true
+require 'jsonapi/store'

data/lib/jsonapi/store.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+require 'jsonapi/store/version'
+
+module JSONAPI
+  # Basic in-memory store implementation compliant with JSON API
+  class Store
+    autoload :Entity, 'jsonapi/store/entity'
+    autoload :Types, 'jsonapi/store/types'
+    autoload :Identifier, 'jsonapi/store/identifier'
+
+    # @param [JSONAPI::Store::Entity] entity
+    # @return [JSONAPI::Store] store itself
+    def <<(entity)
+      entity = Entity.new(entity)
+      entities << entity
+      entity.relationships.each do |_name, data|
+        Array(data).each do |relationship|
+          relationship = Entity.new(relationship)
+          self << relationship unless self[relationship.identifier]
+        end
+      end
+      self
+    end
+
+    # @overload fetch(identifier)
+    #   @param [#to_s] identifier
+    #   @return [JSONAPI::Store::Entity?]
+    # @overload fetch(type, id)
+    #   @param [#to_s] type
+    #   @param [#to_s] id
+    #   @return [JSONAPI::Store::Entity?]
+    def fetch(*args)
+      identifier = args.size == 2 ? args.join('/') : args.first.to_s
+      detect { |entity| entity.identifier == identifier }
+    end
+
+    alias [] fetch
+
+    # @param [#to_s] type
+    # @return [<JSONAPI::Store::Entity>]
+    def all(type)
+      type = type.to_s
+      select { |entity| entity.type == type }
+    end
+
+    # @return [<String>]
+    def types
+      entities.map(&:type).uniq
+    end
+
+    # @return [<JSONAPI::Store::Entity>]
+    def entities
+      @entities ||= []
+    end
+
+    # @return [Integer]
+    def size
+      entities.size
+    end
+
+    # @overload each(&block)
+    #   @return [<JSONAPI::Store::Entity>]
+    # @overload each
+    #   @return [Enumerator<JSONAPI::Store::Entity>]
+    def each(&block)
+      entities.each(&block)
+    end
+
+    include Enumerable
+  end
+end

data/lib/jsonapi/store/entity.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+require 'jsonapi/store'
+require 'jsonapi/store/identifier'
+
+module JSONAPI
+  class Store
+    # Basic entity implementation for {JSONAPI::Store}
+    class Entity < Identifier
+      constructor_type :strict_with_defaults
+
+      # @return [Hash] attributes of the entity
+      attribute :attributes, Types::Optional::Hash
+      # @return [Hash] relationships of the entity
+      attribute :relationships, Types::Optional::Hash
+    end
+  end
+end

data/lib/jsonapi/store/identifier.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+require 'jsonapi/store'
+require 'dry-struct'
+
+module JSONAPI
+  class Store
+    # Basic Identifier implementation for {JSONAPI::Store}
+    class Identifier < Dry::Struct
+      constructor_type :strict
+
+      # @return [String] id of the entity
+      attribute :id, Types::Coercible::String
+      # @return [String] type of the entity
+      attribute :type, Types::Coercible::String
+
+      # @return [String]
+      def identifier
+        @identifier ||= "#{type}/#{id}"
+      end
+      alias to_s identifier
+      alias to_str identifier
+    end
+  end
+end

data/lib/jsonapi/store/types.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+require 'jsonapi/store'
+require 'dry-types'
+
+module JSONAPI
+  class Store
+    # Constrained types for {JSONAPI::Store} entities
+    module Types
+      include Dry::Types.module
+
+      # Add optional Hash for use in {Store::Entity}
+      module Optional
+        Hash = Types::Strict::Hash.optional.default({})
+
+        def Hash.to_s
+          'JSONAPI::Store::Types::Optional::Hash'
+        end
+      end
+    end
+  end
+end

data/lib/jsonapi/store/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+module JSONAPI
+  class Store
+    VERSION = '0.1.0'
+  end
+end

metadata

@@ -0,0 +1,223 @@
+--- !ruby/object:Gem::Specification
+name: jsonapi-store
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alex Semyonov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-10-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: dry-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+- !ruby/object:Gem::Dependency
+  name: simplecov-html
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  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.43.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.43.0
+- !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: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.4
+description: 'Data Store for implementing JSON API-compliant server in Ruby.
+
+'
+email:
+- alex@semyonov.us
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".simplecov"
+- ".travis.yml"
+- ".yardopts"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/rake
+- bin/rspec
+- bin/rubocop
+- bin/setup
+- jsonapi-store.gemspec
+- lib/jsonapi-store.rb
+- lib/jsonapi/store.rb
+- lib/jsonapi/store/entity.rb
+- lib/jsonapi/store/identifier.rb
+- lib/jsonapi/store/types.rb
+- lib/jsonapi/store/version.rb
+homepage: https://github.com/alsemyonov/jsonapi-store
+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.7
+signing_key: 
+specification_version: 4
+summary: JSON API Data Store
+test_files: []