cot 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e7af1b1d15636b337c3561a40786372db55c0400
+  data.tar.gz: 3eee1cb6d6636ec6f1b644c78f268172896ac8b2
+SHA512:
+  metadata.gz: 75cda344dff86f9b42307a8ae9dbcc913a6c7f9de48a2590c6ae578532a38f20447917da9a25b4b52de1cb14e74144a6153ec2edd4bf29e534e606f3f0765bc9
+  data.tar.gz: 417ea29c3e87cd919e063e4e7d55a3a344d81d4593cd1fec6cb5f0bb9554e289203ad6008b76bfd694e3c639a56b43bbb9f78307cd61321f7364caf299ca9d59

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+
+.*swp

data/.ruby-gemset

@@ -0,0 +1 @@
+cot

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.0.0-p247

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,50 @@
+PATH
+  remote: .
+  specs:
+    cot (0.1.0)
+      activemodel
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (4.0.0)
+      activesupport (= 4.0.0)
+      builder (~> 3.1.0)
+    activesupport (4.0.0)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    atomic (1.1.13)
+    builder (3.1.4)
+    diff-lcs (1.2.4)
+    i18n (0.6.5)
+    minitest (4.7.5)
+    multi_json (1.7.9)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.5)
+    rspec-expectations (2.14.2)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.3)
+    shoulda (3.5.0)
+      shoulda-context (~> 1.0, >= 1.0.1)
+      shoulda-matchers (>= 1.4.1, < 3.0)
+    shoulda-context (1.1.5)
+    shoulda-matchers (2.3.0)
+      activesupport (>= 3.0.0)
+    thread_safe (0.1.2)
+      atomic
+    tzinfo (0.3.37)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 1.0.0)
+  cot!
+  rspec
+  shoulda

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Joseph Henrich
+
+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,4 @@
+cot
+===
+
+A gem that helps convert rest calls into models

data/Rakefile

@@ -0,0 +1,13 @@
+# encoding: utf-8
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec') do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rspec_opts = '--tag ~broken'
+end
+
+
+task :default => :spec
+task :test => :spec

data/cot.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "cot/version"
+
+Gem::Specification.new do |s|
+  s.name = 'cot'
+  s.version = Cot::VERSION
+
+  s.authors = ["Joseph Henrich"]
+  s.email = ['crimsonknave@gmail.com']
+  s.homepage = %q{http://github.com/crimsonknave/cot}
+  s.summary = %q{Simplifies creating models for rest based resources}
+  s.description = %q{Simplifies creating models for rest based resources}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'activemodel'
+  s.add_development_dependency 'shoulda', ">= 0"
+  s.add_development_dependency 'bundler', ">= 1.0.0"
+  s.add_development_dependency 'rspec', ">= 0"
+end
+

data/lib/cot.rb

@@ -0,0 +1,12 @@
+require 'active_model'
+
+require 'cot/version'
+require 'cot/frame'
+require 'json'
+
+module Cot
+
+  def version_string
+    "Cot version #{Cot::VERSION}"
+  end
+end

data/lib/cot/frame.rb

@@ -0,0 +1,105 @@
+module Cot
+  class Frame
+    class << self
+      attr_accessor :mappings, :inverted_mappings, :attr_methods, :search_mappings, :inverted_search_mappings
+    end
+    include ActiveModel::Dirty
+
+    def initialize(payload={})
+      @data = convert_keys payload
+    end
+
+    def exists?
+      id
+    end
+
+    def defined_properties
+      self.class.attr_methods
+    end
+    def properties_mapping
+      self.class.mappings
+    end
+
+    def inverted_properties_mapping
+      self.class.inverted_mappings ||= properties_mapping.invert
+    end
+
+    def search_mappings
+      self.class.search_mappings
+    end
+
+    def inverted_search_mappings
+      self.class.inverted_search_mappings ||= search_mappings.invert
+    end
+
+    def self.search_property(name, args={})
+      @search_mappings ||= {}
+
+      key = args[:from] ? args[:from] : name
+      @search_mappings[name] = key
+    end
+
+    # TODO: Create an enum declaration that will automagically map a symbol to
+    # another value (such as an int) so that the user of the library doesn't need
+    # to know what number scheduled status is (for example)
+    def self.enum(name, args={})
+      raise "enum is not yet implemented"
+    end
+
+    def self.property(name, args={})
+      @mappings ||= {}
+      @attr_methods ||= []
+      @search_mappings ||= {}
+      key = args[:from]
+      @mappings[key.to_sym] = name if key
+      @search_mappings[name] = key ? key : name if args[:searchable]
+      attr_methods << name.to_sym
+
+      define_method name do
+        self[name]
+      end
+
+      define_method "#{name}=" do |value|
+        send("#{name}_will_change!") unless value == self[name]
+        self[name] = value
+      end
+      define_attribute_method name
+    end
+
+    def [](key)
+      @data[convert_key key]
+    end
+
+    def []=(key, value)
+      @data[convert_key key] = value
+    end
+
+    def to_json
+      serializable_hash.to_json
+    end
+
+    def serializable_hash
+      attrs = {}
+      defined_properties.each do |m|
+        attrs[inverted_properties_mapping.fetch(m,m)] = self[m]
+      end
+      attrs
+    end
+
+    private
+    def convert_key(key)
+      key = key.to_sym
+      properties_mapping.fetch(key, key).to_sym
+    end
+
+    def convert_keys(hash)
+      return {} unless hash
+      {}.tap do |ret|
+        hash.each_pair do |k,v|
+          ret[convert_key k] = v
+        end
+      end
+    end
+
+  end
+end

data/lib/cot/version.rb

@@ -0,0 +1,3 @@
+module Cot
+  VERSION = '0.1.0'
+end

data/spec/lib/cot/frame_spec.rb

@@ -0,0 +1,87 @@
+require 'spec_helper'
+describe Cot::Frame do
+  before :each do
+    class TestObject < Cot::Frame
+      property :foo, :from => :bar
+      property :id
+      search_property :john, :from => :crichton
+    end
+    @foo = TestObject.new(:bar => 'this will be foo', :id => 5)
+  end
+  subject { @foo }
+  its(:to_json) { should be_kind_of String }
+  its(:serializable_hash) { should be_kind_of Hash }
+  its(:serializable_hash) { should have(2).keys }
+  it 'should have more serialziable tests'
+  its(:id) { should eq 5 }
+  its(:foo) { should eq 'this will be foo' }
+
+  context 'exists?' do
+    it 'should be true if id is present' do
+      @foo.exists?.should be_true
+    end
+    it 'should be false if id is not present' do
+      foo = TestObject.new(:foo => 5)
+      foo.exists?.should be_false
+    end
+  end
+  context 'defined_properties' do
+    it 'should include foo' do
+      @foo.defined_properties.should include :foo
+    end
+    it 'should be an array' do
+      @foo.defined_properties.should be_kind_of Array
+    end
+  end
+  context 'properties_mapping' do
+    it 'should have bar => foo' do
+      @foo.properties_mapping.should have_key :bar
+      @foo.properties_mapping[:bar].should eq :foo
+    end
+  end
+  context 'inverted_properties_mapping' do
+    it 'should have foo => bar' do
+      @foo.inverted_properties_mapping.should have_key :foo
+      @foo.inverted_properties_mapping[:foo].should eq :bar
+    end
+  end
+  context 'search_mappings' do
+    it 'should have john => crichton' do
+      @foo.search_mappings.should have_key :john
+      @foo.search_mappings[:john].should eq :crichton
+    end
+  end
+  context 'inverted_search_mappings' do
+    it 'should have crichton => john' do
+      @foo.inverted_search_mappings.should have_key :crichton
+      @foo.inverted_search_mappings[:crichton].should eq :john
+    end
+  end
+  context 'search_property' do
+    it 'should add to search_mappings' do
+      TestObject.search_mappings.should have_key :john
+      TestObject.search_mappings[:john].should be :crichton
+    end
+  end
+  context 'property' do
+    it 'should add to mappings' do
+      TestObject.mappings.should have_key :bar
+      TestObject.mappings[:bar].should be :foo
+    end
+    it 'should create accessor methods' do
+      foo = TestObject.new
+      foo.should respond_to :foo
+      foo.should respond_to :foo=
+    end
+
+    it 'should add to attr_methods' do
+      TestObject.attr_methods.should include(:foo)
+    end
+
+    it 'accessor methods should use []' do
+      foo = TestObject.new
+      foo.should_receive('[]').once.and_return 'this is foo'
+      foo.foo.should eq 'this is foo'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+ENV['RAILS_ENV'] ||= 'test'
+
+require 'cot'
+require 'rspec'
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.formatter = 'documentation'
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: cot
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joseph Henrich
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  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: shoulda
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.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'
+description: Simplifies creating models for rest based resources
+email:
+- crimsonknave@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-gemset
+- .ruby-version
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- cot.gemspec
+- lib/cot.rb
+- lib/cot/frame.rb
+- lib/cot/version.rb
+- spec/lib/cot/frame_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/crimsonknave/cot
+licenses: []
+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.0.6
+signing_key: 
+specification_version: 4
+summary: Simplifies creating models for rest based resources
+test_files:
+- spec/lib/cot/frame_spec.rb
+- spec/spec_helper.rb