http_api_tools 0.3.0

data/spec/http_api_tools/sideloading/sideload_map_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+require 'http_api_tools/sideloading/sideload_map'
+
+module HttpApiTools
+  module Sideloading
+
+    describe SideloadMap do
+
+      let(:json) do
+        {
+          'meta' => {
+            'root_key' => 'posts'
+          },
+          'posts' => [{
+            'id' => 1,
+            'title' => 'Post Title'
+          }],
+          'linked' => {
+            'images' => [
+              {'id' => 10, 'url' => '1.png' },
+              {'id' => 11, 'url' => '2.png' }
+            ],
+            'comments' => [
+              {'id' => 20, 'text' => 'Comment 1'}
+            ]
+          }
+        }
+
+      end
+
+      let(:sideload_map) { SideloadMap.new(json, 'posts') }
+
+      describe 'getting sideloaded json from the map' do
+
+        it 'returns object at root key' do
+          expect(sideload_map.get('post', 1)['id']).to eql 1
+        end
+
+        it 'retrieves by singular type' do
+          expect(sideload_map.get('image', 10)['id']).to eql 10
+        end
+
+        it 'retrieves by plural type' do
+          expect(sideload_map.get('images', 11)['id']).to eql 11
+        end
+
+        it 'retrieves with string type' do
+          expect(sideload_map.get('comment', 20)['id']).to eql 20
+        end
+
+        it 'returns nil if object not present' do
+          expect(sideload_map.get('foo', 100)).to be_nil
+        end
+
+      end
+
+    end
+  end
+end

data/spec/http_api_tools/support/company_deserializer_mapping.rb

@@ -0,0 +1,11 @@
+# encoding: utf-8
+
+require 'http_api_tools/sideloading/json_deserializer_mapping'
+
+class CompanyDeserializerMapping
+
+  include HttpApiTools::Sideloading::JsonDeserializerMapping
+
+  map :employees, Person
+
+end

data/spec/http_api_tools/support/person_deserializer_mapping.rb

@@ -0,0 +1,9 @@
+require 'http_api_tools/sideloading/json_deserializer_mapping'
+
+class PersonDeserializerMapping
+
+  include HttpApiTools::Sideloading::JsonDeserializerMapping
+
+  map :employer, Company
+
+end

data/spec/http_api_tools/support/spec_models.rb

@@ -0,0 +1,89 @@
+# encoding: utf-8
+
+require 'http_api_tools/model'
+require 'ostruct'
+
+
+class Person
+
+  include HttpApiTools::Model::Attributes
+
+  attribute :id
+  attribute :first_name
+  attribute :last_name
+  attribute :dob
+  attribute :email
+  belongs_to :employer
+  has_many :skills
+
+  def employer_id
+    employer.try(:id)
+  end
+
+  #Act like active record for reflectively interogating type info
+  def self.reflections
+    {
+      employer: OpenStruct.new(class_name: 'Company'),
+      skills:   OpenStruct.new(class_name: 'Skill')
+    }
+  end
+
+end
+
+class Company
+
+  include HttpApiTools::Model::Attributes
+
+  attribute :id
+  attribute :name
+  attribute :brand, read_only: true
+  has_many :employees
+  has_many :suppliers
+  belongs_to :parent_company
+  belongs_to :address
+
+
+  #Act like active record for reflectively interogating type info
+  def self.reflections
+    {
+      employees:      OpenStruct.new(class_name: 'Person'),
+      suppliers:      OpenStruct.new(class_name: 'Company'),
+      parent_company: OpenStruct.new(class_name: 'Company'),
+      address:        OpenStruct.new(class_name: 'Address')
+    }
+  end
+
+end
+
+class Skill
+
+  include HttpApiTools::Model::Attributes
+
+  attribute :id
+  attribute :name
+  attribute :description
+  belongs_to :person
+
+  def person_id
+    person.try(:id)
+  end
+
+  #Act like active record for reflectively interogating type info
+  def self.reflections
+    {
+      person: OpenStruct.new(class_name: 'Person')
+    }
+  end
+
+end
+
+class Address
+
+  attr_accessor :id, :street_address
+
+  def initialize(attrs)
+    @id = attrs[:id]
+    @street_address = attrs[:street_address]
+  end
+
+end

data/spec/http_api_tools/support/spec_nesting_serializers.rb

@@ -0,0 +1,41 @@
+require 'http_api_tools/nesting/json_serializer'
+
+module HttpApiTools
+  module Nesting
+    class PersonSerializer
+
+      include HttpApiTools::Nesting::JsonSerializer
+
+      serializes Person
+      attributes :id, :first_name, :last_name, :full_name, :dob, :email
+      has_one :employer
+      has_many :skills
+
+      def full_name
+        "#{serializable.first_name} #{serializable.last_name}"
+      end
+
+    end
+
+    class CompanySerializer
+
+      include HttpApiTools::Nesting::JsonSerializer
+
+      serializes Company
+      attributes :id, :name
+      has_many :employees
+
+    end
+
+
+    class SkillSerializer
+
+      include HttpApiTools::Nesting::JsonSerializer
+
+      serializes Skill
+      attributes :id, :name, :description
+      has_one :person
+
+    end
+  end
+end

data/spec/http_api_tools/support/spec_sideloading_serializers.rb

@@ -0,0 +1,41 @@
+require 'http_api_tools/sideloading/json_serializer'
+
+module HttpApiTools
+  module Sideloading
+    class PersonSerializer
+
+      include HttpApiTools::Sideloading::JsonSerializer
+
+      serializes Person
+      attributes :id, :first_name, :last_name, :full_name, :dob, :email
+      has_one :employer
+      has_many :skills
+
+      def full_name
+        "#{serializable.first_name} #{serializable.last_name}"
+      end
+
+    end
+
+    class CompanySerializer
+
+      include HttpApiTools::Sideloading::JsonSerializer
+
+      serializes Company
+      attributes :id, :name
+      has_many :employees
+
+    end
+
+
+    class SkillSerializer
+
+      include HttpApiTools::Sideloading::JsonSerializer
+
+      serializes Skill
+      attributes :id, :name, :description
+      has_one :person
+
+    end
+  end
+end

data/spec/http_api_tools/type_key_resolver_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+require 'http_api_tools/type_key_resolver'
+
+module HttpApiTools
+
+  describe TypeKeyResolver do
+
+    let(:resolver) { TypeKeyResolver.new }
+
+    describe 'resolving class names' do
+
+      it 'correctly resolves the type key multiple times' do
+        expect(resolver.for_class(String)).to eq 'strings'
+        expect(resolver.for_class(String)).to eq 'strings'
+      end
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+# encoding: utf-8
+
+require 'http_api_tools/support/spec_models'
+require 'http_api_tools/support/spec_sideloading_serializers'
+require 'http_api_tools/support/spec_nesting_serializers'
+require 'active_support/core_ext/hash/indifferent_access'
+require 'rubygems'
+require 'pry'

metadata

@@ -0,0 +1,214 @@
+--- !ruby/object:Gem::Specification
+name: http_api_tools
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Rob Monie
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: activesupport
+  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: rspec
+  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: pry
+  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: pry-debugger
+  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: ruby-prof
+  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'
+description: Http API Tools
+email:
+- robmonie@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- http_api_tools.gemspec
+- lib/http_api_tools.rb
+- lib/http_api_tools/base_json_serializer.rb
+- lib/http_api_tools/expanded_relation_includes.rb
+- lib/http_api_tools/identity_map.rb
+- lib/http_api_tools/json_serializer_dsl.rb
+- lib/http_api_tools/model.rb
+- lib/http_api_tools/model/acts_like_active_model.rb
+- lib/http_api_tools/model/attributes.rb
+- lib/http_api_tools/model/has_many_array.rb
+- lib/http_api_tools/model/transformers/date_time_transformer.rb
+- lib/http_api_tools/model/transformers/registry.rb
+- lib/http_api_tools/nesting/json_serializer.rb
+- lib/http_api_tools/nesting/relation_loader.rb
+- lib/http_api_tools/relation_includes.rb
+- lib/http_api_tools/serializer_registry.rb
+- lib/http_api_tools/sideloading/json_deserializer.rb
+- lib/http_api_tools/sideloading/json_deserializer_mapping.rb
+- lib/http_api_tools/sideloading/json_serializer.rb
+- lib/http_api_tools/sideloading/relation_sideloader.rb
+- lib/http_api_tools/sideloading/sideload_map.rb
+- lib/http_api_tools/type_key_resolver.rb
+- lib/http_api_tools/version.rb
+- reports/empty.png
+- reports/minus.png
+- reports/plus.png
+- spec/http_api_tools/expanded_relation_includes_spec.rb
+- spec/http_api_tools/identity_map_spec.rb
+- spec/http_api_tools/model/attributes_spec.rb
+- spec/http_api_tools/model/has_many_array_spec.rb
+- spec/http_api_tools/model/transformers/date_time_transformer_spec.rb
+- spec/http_api_tools/model/transformers/registry_spec.rb
+- spec/http_api_tools/nesting/json_serializer_spec.rb
+- spec/http_api_tools/relation_includes_spec.rb
+- spec/http_api_tools/sideloading/json_deserializer_spec.rb
+- spec/http_api_tools/sideloading/json_serializer_performance_spec.rb
+- spec/http_api_tools/sideloading/json_serializer_spec.rb
+- spec/http_api_tools/sideloading/sideload_map_spec.rb
+- spec/http_api_tools/support/company_deserializer_mapping.rb
+- spec/http_api_tools/support/person_deserializer_mapping.rb
+- spec/http_api_tools/support/spec_models.rb
+- spec/http_api_tools/support/spec_nesting_serializers.rb
+- spec/http_api_tools/support/spec_sideloading_serializers.rb
+- spec/http_api_tools/type_key_resolver_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Provides JSON serialization/deserialization and basic model attribute definition
+  for client apps
+test_files:
+- spec/http_api_tools/expanded_relation_includes_spec.rb
+- spec/http_api_tools/identity_map_spec.rb
+- spec/http_api_tools/model/attributes_spec.rb
+- spec/http_api_tools/model/has_many_array_spec.rb
+- spec/http_api_tools/model/transformers/date_time_transformer_spec.rb
+- spec/http_api_tools/model/transformers/registry_spec.rb
+- spec/http_api_tools/nesting/json_serializer_spec.rb
+- spec/http_api_tools/relation_includes_spec.rb
+- spec/http_api_tools/sideloading/json_deserializer_spec.rb
+- spec/http_api_tools/sideloading/json_serializer_performance_spec.rb
+- spec/http_api_tools/sideloading/json_serializer_spec.rb
+- spec/http_api_tools/sideloading/sideload_map_spec.rb
+- spec/http_api_tools/support/company_deserializer_mapping.rb
+- spec/http_api_tools/support/person_deserializer_mapping.rb
+- spec/http_api_tools/support/spec_models.rb
+- spec/http_api_tools/support/spec_nesting_serializers.rb
+- spec/http_api_tools/support/spec_sideloading_serializers.rb
+- spec/http_api_tools/type_key_resolver_spec.rb
+- spec/spec_helper.rb
+has_rdoc: