cot 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e7af1b1d15636b337c3561a40786372db55c0400
-  data.tar.gz: 3eee1cb6d6636ec6f1b644c78f268172896ac8b2
+  metadata.gz: 531b8bbb2c943a86b2d9041c9b084f5dd4c9bc06
+  data.tar.gz: f0cebfb0d17cffa7a1f69584662644da4fdfce42
 SHA512:
-  metadata.gz: 75cda344dff86f9b42307a8ae9dbcc913a6c7f9de48a2590c6ae578532a38f20447917da9a25b4b52de1cb14e74144a6153ec2edd4bf29e534e606f3f0765bc9
-  data.tar.gz: 417ea29c3e87cd919e063e4e7d55a3a344d81d4593cd1fec6cb5f0bb9554e289203ad6008b76bfd694e3c639a56b43bbb9f78307cd61321f7364caf299ca9d59
+  metadata.gz: f294e13567ac759dff0966a1fc821428d93a749c483de4bc1c0053636e0e13afb03cfd5f3f9c6d789e4e37c2994047fa5f7c8ee201e03b2da26462201cafc590
+  data.tar.gz: 2af05c7c27c7ccf7cf0cd39390f9e59c396e00511d68b415e85a25ad000565f3fddb00270dd33d92fb2e5d93e18b48fc858c42fdec917efc6ca958048f2d2be9

data/README.md

@@ -1,4 +1,36 @@
 cot
 ===
 
-A gem that helps convert rest calls into models
+Cot is a gem designed to help convert rest based resources into ruby objects.  Currently it only handles converting the responses into objects and doesn't deal with the requests themselves, there are plenty of gems for that out there.
+
+### Usage
+
+Using cot is pretty simple, include it in your project and then have your class inherit from Cot::Frame.
+
+Frame provides some helpful methods:
+- Class Methods
+    - property adds the first parameter as an accessor on the object.  There are two optional arguments, from and searchable.  From indicates that the property has an alternate key in the incoming/outgoing data.  Searchable adds the property to the search mappings.
+    - search\_property adds the parameter to the search mapping.  It takes an optional from argument which inidates the property has an alternate key in the incoming/outgoing data.
+- Instance Methods
+    - defined\_properties returns a list of the defined properties
+    - properties\_mapping returns a hash containing all of the renamed properties.  The keys are the values of the from argument and the values are the property name.
+    - inverted\_properties\_mapping returns an inverted hash containing all of the renamed properties.  This is the same as properties\_mapping but the property names are the keys and the froms are the values
+    - search\_mappings returns a hash containing the search properties.  If a from was provided then that is the key otherwise the key and the value will be the property name.
+    - inverted\_search\_mappings returns an inverted search\_mappings hash.
+    - serializable\_hash returns hash with the correct keys to post back.  AKA, it reverts the keys to what the from arguments (if any) were.
+    - to\_json returns a json encoded version of serializable\_hash.
+
+```ruby
+class ExampleObject < Cot::Frame
+  property :id
+  property :name, :searchable => true
+  property :company_name, :from => :companyName
+  search_property :created_at, :from => :createdOn
+end
+
+thingy = ExampleObject.new(id: :my_id, name: 'awesome name', createdOn: Time.now)
+thingy.id # 5
+thingy.name # awesome name
+thingy.created_at # what time it is now
+thingy.defined\_properties # [:id, :name, :created_at]
+```

data/lib/cot/frame.rb

@@ -10,6 +10,7 @@ module Cot
     end
 
     def exists?
+      #TODO: Have this key off a defined primary key instead of defaulting to id
       id
     end
 

data/lib/cot/rspec/matchers.rb

@@ -0,0 +1,54 @@
+RSpec::Matchers.define :set_search_property do |field|
+  match do |base|
+    if @from
+      base.search_mappings[field] == @from
+    else
+      base.search_mappings[field] == field
+    end
+  end
+
+  def from(from)
+    @from = from
+    self
+  end
+end
+RSpec::Matchers.define :set_property do |field|
+  match do |base|
+    @tests = {}
+    @tests[:attr_methods] = base.attr_methods.include?(field.to_sym)
+    if @from
+      @tests[:mappings] =  base.mappings[@from.to_sym] == field
+    end
+    if @searchable
+      key = @from ? @from : field
+      @tests[:searchable] = base.search_mappings[field] == key
+    end
+    example = base.new
+    @tests[:reader] = example.respond_to?(field)
+    @tests[:accessor] = example.respond_to?("#{field}=")
+    @tests[:dirty] = example.respond_to?("#{field}_changed?")
+    @tests.values.all?
+  end
+
+  def from(from)
+    @from = from
+    self
+  end
+  def searchable
+    @searchable = true
+    self
+  end
+
+  description do
+    from_string = @from ? "from #{@from}" : ""
+    search_string = @searchable ? "to be searchable" : ""
+    "should set property #{field} #{from_string} #{search_string}"
+  end
+
+  failure_message_for_should do
+    failed = @tests.select{|k,v| !v}.keys
+    "Expected the property #{field} to be set, but the following attributes weren't set correctly #{failed}"
+  end
+
+end
+

data/lib/cot/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cot
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Joseph Henrich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-22 00:00:00.000000000 Z
+date: 2014-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -84,6 +84,7 @@ files:
 - cot.gemspec
 - lib/cot.rb
 - lib/cot/frame.rb
+- lib/cot/rspec/matchers.rb
 - lib/cot/version.rb
 - spec/lib/cot/frame_spec.rb
 - spec/spec_helper.rb
@@ -106,7 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.6
+rubygems_version: 2.1.9
 signing_key: 
 specification_version: 4
 summary: Simplifies creating models for rest based resources