json_api_model 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e8108fc0f24c943231c25e571dd4e53bbdd7c81b
+  data.tar.gz: 514bc267aaea9904075f23c714e997ad7c6a3632
+SHA512:
+  metadata.gz: 280163fa58e09398bf0798928a81040d178a3d35e202e2423b136ebde61cc0bae6e2ed4f1d48c1d25909ed81ee744ba47206aede851e6ab1292f7969ad789082
+  data.tar.gz: 5d01cb61d2fdf30de41080617bdc73d61b332b09d5d53942934d388351fb3839335afb65589251b07c62136ddd204bb82b0655b7db59c7b9cde2cc7f3e07bb6d

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

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

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 gaorlov@gmail.com. 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,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in json_api_model.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Greg Orlov
+
+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,43 @@
+# JsonApiModel
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/json_api_model`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'json_api_model'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install json_api_model
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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 `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec 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/[USERNAME]/json_api_model. 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
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the JsonApiModel project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/json_api_model/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "json_api_model"
+
+# 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(__FILE__)

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/json_api_model.gemspec

@@ -0,0 +1,28 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "json_api_model/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "json_api_model"
+  spec.version       = JsonApiModel::VERSION
+  spec.authors       = ["Greg Orlov"]
+  spec.email         = ["gaorlov@gmail.com"]
+
+  spec.summary       = "Wrapper for JsonApiClient for in-app business logic."
+  spec.homepage      = "http://github.com/gaorlov/json_api_model"
+  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_dependency "json_api_client"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/json_api_model/instrumenter/null_instrumenter.rb

@@ -0,0 +1,9 @@
+module JsonApiModel
+  module Instrumenter
+    class NullInstrumenter
+      def instrument( name, payload = {} )
+        yield payload
+      end
+    end
+  end
+end

data/lib/json_api_model/instrumenter.rb

@@ -0,0 +1,5 @@
+module JsonApiModel
+  module Instrumenter
+    autoload :NullInstrumenter,  'json_api_model/instrumenter/null_instrumenter'
+  end
+end

data/lib/json_api_model/model.rb

@@ -0,0 +1,45 @@
+module JsonApiModel
+  class Model
+    class << self
+      extend Forwardable
+
+      def_delegators :_new_scope, :where, :order, :includes, :select, :all, :paginate, :page, :with_params, :first, :find, :last
+
+      attr_reader :client_class
+      def wraps( client_class )
+        @client_class = client_class
+      end
+
+      def new_from_client( client )
+        model = new
+        model.client = client
+      end
+
+      def connection( &block )
+        client_class.connection true, &block
+      end
+
+      private
+
+      def _new_scope
+        Scope.new( self )
+      end
+    end
+
+    attr_reader :client
+
+    def initialize( attributes = {} )
+      @client = self.class.client_class.new( attributes )
+    end
+
+    def method_missing( m, *args, &block )
+      client.send m, *args, &block
+    end
+
+    private
+
+    def client=( client )
+      @client = client
+    end
+  end
+end

data/lib/json_api_model/result_set.rb

@@ -0,0 +1,25 @@
+module JsonApiModel
+  class ResultSet
+    def initialize( client_result_set, resource_class )
+      @set = client_result_set
+    end
+
+    def as_json
+      if block_given?
+        yield @set, meta
+      else
+        { data: @set,
+          meta: meta
+        }
+      end
+    end
+
+    def meta
+      @set.meta.attributes
+    end
+
+    def method_missing( m, *args, &block )
+      @set.send m, *args, &block
+    end
+  end
+end

data/lib/json_api_model/scope.rb

@@ -0,0 +1,59 @@
+module JsonApiModel
+  class Scope
+    def initialize( resource_class )
+      @resource_class = resource_class
+      @client_scope   = JsonApiClient::Query::Builder.new( resource_class.client_class )
+    end
+
+    def to_a
+      @to_a ||= find
+    end
+
+    alias all to_a
+
+
+    def find( args = {} )
+      JsonApiModel.instrumenter.instrument 'find.json_api_model',
+                                            args: args,
+                                            url: url do
+        results = @client_scope.find args
+        ResultSet.new( results, @resource_class )
+      end
+    end
+
+    def first
+      JsonApiModel.instrumenter.instrument 'first.json_api_model', url: url do
+        @resource_class.new_from_client @client_scope.first
+      end
+    end
+
+    def last
+      JsonApiModel.instrumenter.instrument 'last.json_api_model', url: url do
+        @resource_class.new_from_client @client_scope.last
+      end
+    end
+
+    def build
+      @resource_class.new_from_client @client_scope.build
+    end
+
+    def params
+      @client_scope.params
+    end
+
+    def method_missing( m, *args, &block )
+      if @client_scope.respond_to? m
+        @client_scope.send m, *args, &block
+        self
+      else
+        all.send m, *args, &block
+      end
+    end
+
+    private
+
+    def url
+      @resource_class.client_class.requestor.send( :resource_path, params )
+    end
+  end
+end

data/lib/json_api_model/version.rb

@@ -0,0 +1,3 @@
+module JsonApiModel
+  VERSION = "0.1.0"
+end

data/lib/json_api_model.rb

@@ -0,0 +1,15 @@
+require "json_api_model/version"
+
+module JsonApiModel
+
+  autoload :Model,        'json_api_model/model'
+  autoload :Instrumenter, 'json_api_model/instrumenter'
+  autoload :ResultSet,    'json_api_model/result_set'
+  autoload :Scope,        'json_api_model/scope'
+
+  class << self
+    attr_accessor :instrumenter
+  end
+
+  self.instrumenter = Instrumenter::NullInstrumenter.new
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: json_api_model
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Greg Orlov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-07-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json_api_client
+  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: 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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 
+email:
+- gaorlov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- json_api_model.gemspec
+- lib/json_api_model.rb
+- lib/json_api_model/instrumenter.rb
+- lib/json_api_model/instrumenter/null_instrumenter.rb
+- lib/json_api_model/model.rb
+- lib/json_api_model/result_set.rb
+- lib/json_api_model/scope.rb
+- lib/json_api_model/version.rb
+homepage: http://github.com/gaorlov/json_api_model
+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.14
+signing_key: 
+specification_version: 4
+summary: Wrapper for JsonApiClient for in-app business logic.
+test_files: []