cartograph 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 75a2908b56243cc37194669f69b38f4b98b98674
+  data.tar.gz: d6ef9fc6b4ada540498ba187594fdff5234767aa
+SHA512:
+  metadata.gz: 46424d9ba2555a11ea4acac0ad660259b5b46d47b9a1da40226c9dd8695cb7df22a6f82d4c02c2c9a5339b15290c5ffacaec91e6329c1d210b2d0939dd71a8ea
+  data.tar.gz: 4bc57fb275ea7f6f3f349af9e08f34ca20c9d302b7612ae1575c1d942b86d05dc6a624170df72bed91b4d0d334d4b933be59df0dffb023d8a6fe6058928db307

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.pairs

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.1
+  - 2.0.0

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+Cartograph Changelog
+====================
+
+### master
+
+### [v1.0.0][v1.0.0] (September 7, 2017)
+
+* Added support for dry-struct
+  ([#3](https://github.com/kyrylo/cartograph/pull/3))
+
+[v1.0.0]: https://github.com/kyrylo/cartograph/releases/tag/v1.0.0

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Robert Ross
+
+MIT License
+
+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,211 @@
+# Cartograph
+
+A Serialization / Deserialization library.
+
+[![Build Status](https://travis-ci.org/kyrylo/cartograph.svg?branch=master)](https://travis-ci.org/kyrylo/cartograph)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'cartograph'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Cartograph makes it easy to generate and convert JSON. It's intention is to be used for API clients.
+
+For example, if you have an object that you would like to convert to JSON for a create request to an API. You would have something similar to this:
+
+```ruby
+class UserMapping
+  include Cartograph::DSL
+
+  cartograph do
+    mapping User # The object we're mapping
+
+    property :name, :email, scopes: [:create, :update]
+    property :id, scopes: :read
+  end
+end
+
+user = User.new(name: 'Bobby Tables')
+json_for_create = UserMapping.representation_for(:create, user)
+```
+
+### Rendering Objects or Collections as Hashes
+
+```ruby
+user = User.new(name: 'PB Jelly')
+users = [user]
+
+hash = UserMapping.hash_for(:read, user)
+hash_collection = UserMapping.hash_collection_for(:read, user)
+```
+
+### Rendering Collections as JSON
+
+```ruby
+user = User.new(name: 'Bobby Tables')
+users = Array.new(10, user)
+
+json = UserMapping.represent_collection_for(:read, users)
+```
+
+---
+
+Some API's will give you the created resource back as JSON as well on a successful create. For that, you may do something like this:
+
+```ruby
+response = HTTPClient.post("http://something.com/api/users", body: json_for_create)
+created_user = UserMapping.extract_single(response.body, :read)
+```
+
+Most API's will have a way of retrieving an entire resource collection. For this you can instruct Cartograph to convert a collection.
+
+```ruby
+response = HTTPClient.get("http://something.com/api/users")
+users = UserMapping.extract_collection(response.body, :read)
+# => [ User, User, User ]
+```
+
+### Getting Harder
+
+Sometimes resources will nest other properties under a key. Cartograph can handle this as well.
+
+```ruby
+class UserMapping
+  include Cartograph::DSL
+
+  cartograph do
+    mapping User # The object we're mapping
+
+    property :name, scopes: [:read]
+
+    property :comments do
+      mapping Comment # The nested object we're mapping
+
+      property :text, scopes: [:read]
+      property :author, scopes: [:read]
+    end
+  end
+end
+```
+
+Just like the previous examples, when you serialize this. It will include the comment block for the scope defined.
+
+### Root Keys
+
+Cartograph can also handle the event of root keys in response bodies. For example, if you receive a response with:
+
+```json
+{ "user": { "id": 123 } }
+```
+
+You could define a mapping like this:
+
+
+```ruby
+class UserMapping
+  include Cartograph::DSL
+
+  cartograph do
+    mapping User
+    root_key singular: 'user', plural: 'users', scopes: [:read]
+    property :id, scopes: [:read]
+  end
+end
+```
+
+This means that when you call the same thing:
+
+```ruby
+response = HTTPClient.get("http://something.com/api/users")
+users = UserMapping.extract_collection(response.body, :read)
+```
+
+It will look for the root key before trying to deserialize the JSON response.
+The advantage of this is it will only use the root key if there is a scope defined for it.
+
+
+### Including other definitions within eachother
+
+Sometimes you might have models that are nested within eachother on responses. Or you simply want to cleanup definitions by separating concerns. Cartograph lets you do this with includes.
+
+```ruby
+class UserMapping
+  include Cartograph::DSL
+
+  cartograph do
+    mapping User
+    property :id, scopes: [:read]
+    property :comments, plural: true, include: CommentMapping
+  end
+end
+
+class CommentMapping
+  include Cartograph::DSL
+
+  cartograph do
+    mapping Comment
+    property :id, scopes: [:read]
+    property :text, scopes: [:read]
+  end
+end
+```
+
+
+### Scope blocks
+
+Sometimes adding scopes to all properties can be tedious, to avoid that, you can define properties within a scope block.
+
+```ruby
+class UserMapping
+  include Cartograph::DSL
+
+  cartograph do
+    scoped :read do
+      property :name
+      property :id
+      property :email, key: 'email_address' # The JSON returned has the key of email_address, our property is called email however.
+    end
+
+    scoped :update, :create do
+      property :name
+      property :email, key: 'email_address'
+    end
+  end
+end
+```
+
+Now when JSON includes comments for a user, it will know how to map the comments using the provided Cartograph definition.
+
+---
+
+### Caching
+
+Cartograph has the option to cache certain serializations, determined by the way you setup the key.
+
+```ruby
+class UserMapping
+  include Cartograph::DSL
+
+  cartograph do
+    cache { Rails.cache } # As long as this respond to #fetch(key_name, options = {}, &block) it will work
+    cache_key { |object| object.cache_key }
+
+    end
+  end
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/kyrylo/cartograph/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

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

data/cartograph.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cartograph/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cartograph"
+  spec.version       = Cartograph::VERSION
+  spec.authors       = ["Robert Ross", "Kyrylo Silin"]
+  spec.email         = ["silin@kyrylo.org"]
+  spec.summary       = %q{Cartograph makes it easy to generate and convert JSON. It's intention is to be used for API clients.}
+  spec.description   = %q{Cartograph makes it easy to generate and convert JSON. It's intention is to be used for API clients.}
+  spec.homepage      = "https://github.com/kyrylo/cartograph"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'rspec', '~> 3.6'
+  spec.add_development_dependency 'pry', '~> 0'
+end

data/examples/collection_representation.rb

@@ -0,0 +1,41 @@
+require 'cartograph'
+require 'pp'
+
+class User < Struct.new(:id, :name, :comments)
+end
+
+class Comment < Struct.new(:id, :text)
+end
+
+class UserMapping
+  include Cartograph::DSL
+
+  cartograph do
+    mapping User
+
+    property :id, scopes: [:read]
+    property :name, scopes: [:read, :create]
+
+    property :comments, plural: true, scopes: [:read] do
+      mapping Comment
+
+      property :id, scopes: [:read]
+      property :text, scopes: [:read, :create]
+    end
+  end
+end
+
+user = User.new(1, 'he@he.com')
+comment = Comment.new(12, 'aksjdfhasjkdfh')
+
+user.comments = Array.new(3, comment)
+users = Array.new(4, user)
+
+json = UserMapping.represent_collection_for(:read, users)
+puts "The JSON generated from that collection:"
+puts json
+
+users_again = UserMapping.extract_collection(json, :read)
+puts "\n"
+puts "And the JSON slurped back into an array:"
+pp users_again

data/examples/domains.rb

@@ -0,0 +1,54 @@
+require 'cartograph'
+
+json = '{
+  "domains": [
+    {
+      "name": "example.com",
+      "ttl": 1800,
+      "zone_file": "Example zone file text..."
+    }
+  ],
+  "meta": {
+    "total": 1
+  }
+}'
+
+class Domain
+  attr_accessor :name, :ttl, :zone_file
+end
+
+class MetaInformation
+  attr_accessor :total
+end
+
+class DomainMapper
+  include Cartograph::DSL
+
+  cartograph do
+    mapping Domain
+    root_key singular: 'domain', plural: 'domains', scopes: [:read]
+
+    property :name, scopes: [:read]
+    property :ttl, scopes: [:read]
+    property :zone_file, scopes: [:read]
+  end
+end
+
+class MetaInformationMapper
+  include Cartograph::DSL
+
+  cartograph do
+    mapping MetaInformation
+
+    root_key singular: 'meta', scopes: [:read]
+    property :total, scopes: [:read]
+  end
+end
+
+domains = DomainMapper.extract_collection(json, :read)
+meta = MetaInformationMapper.extract_single(json, :read)
+
+puts "Total Domains: #{domains.size}"
+puts domains.map(&:name)
+puts
+puts "Total pages: #{meta.total}"

data/examples/representation_for.rb

@@ -0,0 +1,24 @@
+class Domain
+  attr_accessor :name, :ttl, :zone_file
+end
+
+class DomainMapper
+  include Cartograph::DSL
+
+  cartograph do
+    mapping Domain
+    root_key singular: 'domain', plural: 'domains', scopes: [:read]
+
+    property :name, scopes: [:read, :create]
+    property :ttl, scopes: [:read, :create]
+    property :zone_file, scopes: [:read]
+  end
+end
+
+domain = Domain.new
+domain.name = 'example.com'
+domain.ttl = 3600
+domain.zone_file = "this wont be represented for create"
+
+puts DomainMapper.representation_for(:create, domain)
+#=> {"name":"example.com","ttl":3600}