object_json_mapper 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e3c9d3a3c7d0b38d0cdc2fbc17841cca3ce028a7
+  data.tar.gz: 30cde2c2a57c26d300eec9564c138cc0c59bf226
+SHA512:
+  metadata.gz: 018f71e9d07923bc2bd7c718cc0abd2353a7df1d34b9aadfbf7acedd0a03ae44db479308233266436df0769edddd88f2998f33240624c2f6d12123642131b270
+  data.tar.gz: ab609054b4a783bea7fec658dcdcd058cd9f98b3d3cf5ce1ebc93f09895f3148db56b4e85251117ddb4e0266cf2b2e01e3aa78f91a5a8d913deb0d3fed69f5e2

data/.gitignore

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

data/.rspec

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

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at novikov359@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in object_json_mapper.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Inspire
+
+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,251 @@
+# ObjectJSONMapper
+
+[![CircleCI](https://circleci.com/gh/InspireNL/ObjectJSONMapper.svg?style=svg&circle-token=28455d7bc9acb59984023207070f1f4afdc60d15)](https://circleci.com/gh/InspireNL/ObjectJSONMapper)
+
+* [Installation](#installation)
+* [Usage](#usage)
+  * [Find](#find)
+  * [Where](#where)
+  * [Create](#create)
+  * [Update](#update)
+  * [Delete](#delete)
+* [Attributes](#attributes)
+  * [Defaults](#defaults)
+  * [Coercion](#coercion)
+* [Associations](#associations)
+  * [HasMany](#hasmany)
+  * [BelongsTo / HasOne](#belongsto--hasone)
+* [Scope](#scope)
+* [Pluck](#pluck)
+* [None](#none)
+* [Root](#root)
+* [Configure](#configure)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'object_json_mapper'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install object_json_mapper
+
+## Usage
+
+Set default url for your API in `config/initializers/object_json_mapper.rb`:
+
+```ruby
+require 'object_json_mapper'
+
+ObjectJSONMapper.configure do |config|
+  # Required
+  config.base_url = 'http://localhost:3000'
+
+  # Optional
+  config.headers  = {
+    'Authorization' => 'secret-token'
+  }
+end
+```
+
+Define class, e.g. `User`:
+
+```ruby
+class User < ObjectJSONMapper::Base
+end
+```
+
+### Find
+
+```ruby
+User.find(1)
+# => GET http://localhost:3000/users/1
+```
+
+### Where
+
+```ruby
+User.where(id: 1)
+# => GET http://localhost:3000/users?id=1
+
+User.where(id: 1).where(name: 'Name')
+# => GET http://localhost:3000/users?id=1&name=Name
+```
+
+### Create
+
+```ruby
+User.create(name: 'Name')
+# => POST http://localhost:3000/users
+# =>   {
+# =>     name: 'Name'
+# =>   }
+```
+
+### Update
+
+```ruby
+u = User.find(1)
+u.update(name: 'Name')
+# => PATCH http://localhost:3000/users/1
+# =>   {
+# =>     name: 'Name'
+# =>   }
+```
+
+### Delete
+
+```ruby
+u = User.find(1)
+u.delete
+# => DELETE http://localhost:3000/users/1
+```
+
+## Attributes
+
+### Defaults
+
+Executes given `Proc` if value is `nil`.
+
+```ruby
+class User < ObjectJSONMapper::Base
+  attribute :created_at, default: -> { DateTime.now }
+end
+```
+
+### Coercion
+
+Expects a object with `#call` interface to return modified value.
+
+```ruby
+class User < ObjectJSONMapper::Base
+  attribute :created_at, type: Dry::Types['form.date_time']
+end
+```
+
+## Associations
+
+### HasMany
+
+Returns a `Relation` with model objects.
+
+```ruby
+class User < ObjectJSONMapper::Base
+  has_many :posts
+end
+
+User.find(1).posts
+# => GET http://localhost:3000/users/1/posts
+```
+
+### BelongsTo / HasOne
+
+Returns a single model object.
+
+```ruby
+class Post < ObjectJSONMapper::Base
+  belongs_to :user
+  has_one :image
+end
+
+Post.find(1).user
+# => GET http://localhost:3000/posts/1/user
+
+Post.find(1).image
+# => GET http://localhost:3000/posts/1/image
+```
+
+## Scope
+
+Defines a scope for current model and all it relations.
+It's possible to chain `#where` methods and defined scopes in any order.
+
+```ruby
+class User < ObjectJSONMapper::Base
+  scope :published, -> { where(published: true) }
+  scope :active, -> { where(active: true) }
+end
+
+User.published
+# => GET http://localhost:3000/users?published=true
+
+User.published.active
+# => GET http://localhost:3000/users?published=true&active=true
+
+User.published.where(active: true)
+# => GET http://localhost:3000/users?published=true&active=true
+
+User.where(active: true).published
+# => GET http://localhost:3000/users?active=true&published=true
+```
+
+## Pluck
+
+```ruby
+User.where(published: true).pluck(:id, :email)
+# => GET http://localhost:3000/users?published=true
+# => [[1, 'first@example.com', [2, 'second@example.com']]
+```
+
+## None
+
+Returns a chainable relation without records, wouldn't make any queries.
+
+```ruby
+User.none
+# => []
+
+User.where(id: 1).none
+# => []
+
+User.none.where(id: 1)
+# => []
+```
+
+## Root
+
+Allows to change resource path for model client.
+
+```ruby
+User.root('people').where(name: 'Name')
+# => GET http://localhost:3000/people?name=Name
+```
+
+## Configure
+
+Available options:
+
+* `root_url` - resource path for current model.
+
+```ruby
+class User < ObjectJSONMapper::Base
+  configure do |c|
+    c.root_url = 'people'
+  end
+end
+
+User.all
+# => GET http://localhost:3000/people
+
+User.find(1)
+# => GET http://localhost:3000/people/1
+
+User.find(1).posts
+# => GET http://localhost:3000/people/1
+# => GET http://localhost:3000/people/1/posts
+```
+
+## License
+
+ObjectJSONMapper is released under the [MIT License](https://github.com/InspireNL/ObjectJSONMapper/blob/master/LICENSE).
+
+## About
+
+ObjectJSONMapper is maintained by [Inspire](https://inspire.nl).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'object_json_mapper'
+require 'pry'
+# require 'irb'
+
+ObjectJSONMapper.configure do |config|
+  config.base_url = 'http://localhost:3000/v1/'
+  config.headers  = {
+    'Authorization-Consumer' => '65d064d8-4b52-4b4d-8f5b-acc36a21e3bf'
+  }
+end
+
+class User < ObjectJSONMapper::Base
+  attribute :id
+  attribute :email
+  attribute :password
+
+  has_many :subscriptions
+
+  scope :qwe, -> { where(id: 1) }
+
+  configure do |c|
+    c.root_url = 'children'
+  end
+end
+
+class Subscription < ObjectJSONMapper::Base
+  belongs_to :user
+end
+
+Pry.start
+# IRB.start

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/lib/object_json_mapper/associations/association.rb

@@ -0,0 +1,36 @@
+module ObjectJSONMapper
+  module Associations
+    # Base class for association builders
+    #
+    # @abstract
+    class Association
+      attr_reader :name, :params
+
+      # @param name [Symbol]
+      # @param options [Hash]
+      # @option options [Object] :klass
+      # @option options [String] :endpoint
+      # @option options [Hash] :params
+      def initialize(name, options = {})
+        @name     = name
+        @klass    = options.fetch(:class_name, name)
+        @endpoint = options.fetch(:endpoint, name)
+        @params   = options.fetch(:params, {})
+      end
+
+      def call(*)
+        raise NotImplementedError
+      end
+
+      def klass
+        return @klass.to_s.classify.constantize if @klass.is_a?(Symbol)
+
+        @klass
+      end
+
+      def endpoint
+        @endpoint.to_s.underscore
+      end
+    end
+  end
+end

data/lib/object_json_mapper/associations/has_many.rb

@@ -0,0 +1,13 @@
+module ObjectJSONMapper
+  module Associations
+    class HasMany < Association
+      # @param object [ObjectJSONMapper::Base]
+      # @return [ObjectJSONMapper::Relation]
+      def call(object)
+        klass.where.tap do |relation|
+          relation.path = object.client[endpoint].url
+        end
+      end
+    end
+  end
+end

data/lib/object_json_mapper/associations/has_one.rb

@@ -0,0 +1,13 @@
+module ObjectJSONMapper
+  module Associations
+    class HasOne < Association
+      # @param object [ObjectJSONMapper::Base]
+      # @return [ObjectJSONMapper::Base]
+      def call(object)
+        klass.persist(
+          HTTP.parse_json(object.client[endpoint].get.body)
+        )
+      end
+    end
+  end
+end

data/lib/object_json_mapper/associations/registry.rb

@@ -0,0 +1,25 @@
+module ObjectJSONMapper
+  module Associations
+    # Collection of model associations
+    class Registry
+      include Enumerable
+
+      attr_reader :associations
+
+      delegate :[],
+               :[]=,
+               :<<,
+               to: :associations
+
+      def initialize
+        @associations = []
+      end
+
+      # @param name [Symbol]
+      # @return [ObjectJSONMapper::Associations::Association]
+      def find(name)
+        associations.find { |a| a.name == name }
+      end
+    end
+  end
+end

data/lib/object_json_mapper/associations.rb

@@ -0,0 +1,96 @@
+module ObjectJSONMapper
+  module Associations
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      # rubocop:disable Style/PredicateName
+      #
+      # @param association_name [Symbol]
+      # @param class_name [Symbol]
+      # @return [ObjectJSONMapper::Relation<ObjectJSONMapper::Base>]
+      #
+      # @example Basic usage
+      #   class User < ObjectJSONMapper::Base
+      #     has_many :products
+      #   end
+      #
+      #   User.find(1).products
+      #   # GET http://localhost:3000/v1/users/1/products
+      #   # => #<ObjectJSONMapper::Relation @collection=[<Product>...]>
+      #
+      # @example With class_name
+      #   class User < ObjectJSONMapper::Base
+      #     has_many :things, class_name: :products
+      #   end
+      #
+      #   User.find(1).things
+      #   # GET http://localhost:3000/v1/users/1/things
+      #   # => #<ObjectJSONMapper::Relation @collection=[<Product>...]>
+      #
+      # @example With endpoint
+      #   class User < ObjectJSONMapper::Base
+      #     has_many :products, endpoint: :things
+      #   end
+      #
+      #   User.find(1).products
+      #   # GET http://localhost:3000/v1/users/1/things
+      #   # => #<ObjectJSONMapper::Relation @collection=[<Product>...]>
+      #
+      # @example With params
+      #   class User < ObjectJSONMapper::Base
+      #     has_many :products, params: { status: :active }
+      #   end
+      #
+      #   User.find(1).products
+      #   # GET http://localhost:3000/v1/users/1/products?status=active
+      #   # => #<ObjectJSONMapper::Relation @collection=[<Product>...]>
+      def has_many(name, options = {})
+        associations << HasMany.new(name, options)
+
+        define_method(name) do |reload = false|
+          cache_name = :"@#{__method__}"
+
+          if instance_variable_defined?(cache_name) && reload == false
+            return instance_variable_get(cache_name)
+          end
+
+          instance_variable_set(
+            cache_name,
+            self.class.associations.find(__method__).call(self)
+          )
+        end
+      end
+
+      # @param association_name [Symbol]
+      # @return [ObjectJSONMapper::Base]
+      #
+      # @example Basic usage
+      #   class User < ObjectJSONMapper::Base
+      #     has_one :profile
+      #   end
+      #
+      #   User.find(1).profile
+      #   # GET http://localhost:3000/v1/users/1/profile
+      #   # => #<ObjectJSONMapper::Base @attributes={...}>
+      def has_one(name, options = {})
+        associations << HasOne.new(name, options)
+
+        define_method(name) do |reload = false|
+          cache_name = :"@#{__method__}"
+
+          if instance_variable_defined?(cache_name) && reload == false
+            return instance_variable_get(cache_name)
+          end
+
+          instance_variable_set(
+            cache_name,
+            self.class.associations.find(__method__).call(self)
+          )
+        end
+      end
+      alias belongs_to has_one
+    end
+  end
+end