arrest 0.0.2 → 0.0.3

data/arrest.gemspec

@@ -21,4 +21,5 @@ Gem::Specification.new do |s|
   # specify any dependencies here; for example:
   # s.add_development_dependency "rspec"
   s.add_runtime_dependency "json"
+  s.add_runtime_dependency "faraday", '0.7.5'
 end

data/lib/arrest.rb

@@ -9,51 +9,4 @@ require "arrest/rest_child"
 
 module Arrest
 
-  String.class_eval do
-
-    PLURALS = [['(quiz)$', '\1zes'],['(ox)$', '\1en'],['([m|l])ouse$', '\1ice'],['(matr|vert|ind)ix|ex$', '\1ices'],
-      ['(x|ch|ss|sh)$', '\1es'],['([^aeiouy]|qu)ies$', '\1y'],['([^aeiouy]|q)y$$', '\1ies'],['(hive)$', '\1s'],
-      ['(?:[^f]fe|([lr])f)$', '\1\2ves'],['(sis)$', 'ses'],['([ti])um$', '\1a'],['(buffal|tomat)o$', '\1oes'],['(bu)s$', '\1es'],
-      ['(alias|status)$', '\1es'],['(octop|vir)us$', '\1i'],['(ax|test)is$', '\1es'],['s$', 's'],['$', 's']]
-    SINGULARS =[['(quiz)zes$', '\1'],['(matr)ices$', '\1ix'],['(vert|ind)ices$', '\1ex'],['^(ox)en$', '\1'],['(alias|status)es$', '\1'],
-      ['(octop|vir)i$', '\1us'],['(cris|ax|test)es$', '\1is'],['(shoe)s$', '\1'],['[o]es$', '\1'],['[bus]es$', '\1'],['([m|l])ice$', '\1ouse'],
-      ['(x|ch|ss|sh)es$', '\1'],['(m)ovies$', '\1ovie'],['[s]eries$', '\1eries'],['([^aeiouy]|qu)ies$', '\1y'],['[lr]ves$', '\1f'],
-      ['(tive)s$', '\1'],['(hive)s$', '\1'],['([^f])ves$', '\1fe'],['(^analy)ses$', '\1sis'],
-      ['([a]naly|[b]a|[d]iagno|[p]arenthe|[p]rogno|[s]ynop|[t]he)ses$', '\1\2sis'],['([ti])a$', '\1um'],['(news)$', '\1ews'], ['(.*)s$', '\1'], ['^(.*)$', '\1']]
-
-    def singular()
-      SINGULARS.each { |match_exp, replacement_exp| return gsub(Regexp.compile(match_exp), replacement_exp) unless match(Regexp.compile(match_exp)).nil?}
-    end
-
-    def plural()
-      PLURALS.each   { |match_exp, replacement_exp| return gsub(Regexp.compile(match_exp), replacement_exp) unless match(Regexp.compile(match_exp)).nil? }
-    end
-
-    def plural?
-      PLURALS.each {|match_exp, replacement_exp| return true if match(Regexp.compile(match_exp))}
-      false
-    end
-
-    def blank? 
-      self == nil || self == ""
-    end
-
-    def classify(upper_first = true)
-      result = ""
-      upperNext = false
-      self.singular.each_char do |c|
-        if c == "_"
-          upperNext = true
-        else
-          if upperNext || (result.blank? && upper_first)
-            result << c.upcase
-          else
-            result << c
-          end
-          upperNext = false
-        end
-      end
-      result
-    end
-  end
 end

data/lib/arrest/abstract_resource.rb

@@ -1,6 +1,10 @@
 require 'json'
+require 'arrest/string_utils'
 
 module Arrest
+
+  Attribute = Struct.new(:name, :read_only)
+
   class AbstractResource
     class << self
 
@@ -11,16 +15,23 @@ module Arrest
       end
 
       def body_root response
+        if response == nil
+          return nil
+        end
         all = JSON.parse response
         all["result"]
       end
 
       def build hash
-        self.new hash
+        underscored_hash = {}
+        hash.each_pair do |k, v|
+          underscored_hash[StringUtils.underscore k] = v
+        end
+        self.new underscored_hash
       end
 
       def resource_name
-        self.name.sub(/.*:/,'').downcase.plural
+       StringUtils.plural self.name.sub(/.*:/,'').downcase
       end
 
       def has_many(*args)
@@ -35,7 +46,7 @@ module Arrest
           end
         end
         send :define_method, method_name do
-         Arrest::Source.mod.const_get(clazz_name.classify).all_for self
+         Arrest::Source.mod.const_get(StringUtils.classify clazz_name).all_for self
         end
       end
 
@@ -46,17 +57,33 @@ module Arrest
         end
       end
 
-      def add_attribute attribute_name
+      def add_attribute attribute
           if @fields == nil
             @fields = []
           end
-          @fields << attribute_name
+          @fields << attribute
+      end
+
+      def all_fields
+        if self.superclass.respond_to?('fields') && self.superclass.fields != nil
+          self.fields + self.superclass.fields
+        else
+          self.fields
+        end
+
+      end
+
+      def read_only_attributes(*args)
+        args.each do |arg|
+          self.send :attr_accessor,arg
+          add_attribute Attribute.new(arg, true)
+        end
       end
 
       def attributes(*args)
         args.each do |arg|
           self.send :attr_accessor,arg
-          add_attribute arg
+          add_attribute Attribute.new(arg, false)
         end
       end
 
@@ -66,7 +93,7 @@ module Arrest
         attributes "#{name}_id".to_sym
         send :define_method, name do
           val = self.instance_variable_get("@#{name}_id")
-          Arrest::Source.mod.const_get(name.classify).find(val)
+          Arrest::Source.mod.const_get(StringUtils.classify name).find(val)
         end
       end
     end
@@ -78,11 +105,9 @@ module Arrest
       as_i.each_pair do |k,v|
         as[k.to_sym] = v
       end
-      unless self.class.fields == nil
-        self.class.fields.each do |field|
-          json_name = field.to_s.classify(false)
-          json_name[0] = json_name[0].downcase
-          self.instance_variable_set("@#{field.to_s}", as[json_name.to_sym]) 
+      unless self.class.all_fields == nil
+        self.class.all_fields.each do |field|
+          self.send("#{field.name.to_s}=", as[field.name.to_sym]) 
         end
       end
       self.id = as[:id]
@@ -90,10 +115,10 @@ module Arrest
 
     def to_hash
       result = {}
-      unless self.class.fields == nil
-        self.class.fields.each do |field|
-          json_name = field.to_s.classify(false)
-          result[json_name] = self.instance_variable_get("@#{field.to_s}")
+      unless self.class.all_fields == nil
+        self.class.all_fields.find_all{|a| !a.read_only}.each do |field|
+          json_name = StringUtils.classify(field.name.to_s,false)
+          result[json_name] = self.instance_variable_get("@#{field.name.to_s}")
         end
       end
       result[:id] = self.id
@@ -109,5 +134,9 @@ module Arrest
       end
     end
 
+    def delete
+      AbstractResource::source().delete self
+    end
+
   end
 end

data/lib/arrest/http_source.rb

@@ -1,3 +1,5 @@
+require 'faraday'
+
 module Arrest
   class HttpSource
 
@@ -6,9 +8,9 @@ module Arrest
     end
 
     def add_headers headers
-      puts "FOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOO"
-      headers['X-SplinkUser'] = '0'
-      headers['Content-Type'] = 'application/json'
+      Arrest::Source.header_decorator.headers.each_pair do |k,v|
+        headers[k.to_s] = v.to_s
+      end
     end
 
     def get sub
@@ -19,6 +21,15 @@ module Arrest
       response.body
     end
 
+    def delete rest_resource
+      raise "To delete an object it must have an id" unless rest_resource.respond_to?(:id) && rest_resource.id != nil
+      response = self.connection().delete do |req|
+        req.url rest_resource.location
+        add_headers req.headers
+      end
+      response.env[:status] == 200
+    end
+
     def put rest_resource
       raise "To change an object it must have an id" unless rest_resource.respond_to?(:id) && rest_resource.id != nil
       hash = rest_resource.to_hash
@@ -37,16 +48,28 @@ module Arrest
       raise "new object must have setter for id" unless rest_resource.respond_to?(:id=)
       raise "new object must not have id" if rest_resource.respond_to?(:id) && rest_resource.id != nil
       hash = rest_resource.to_hash
+      hash.delete(:id)
+      hash.delete('id')
+
+      hash.delete_if{|k,v| v == nil}
       
+      puts "URL:#{rest_resource.class.resource_path}"
+      body = hash.to_json
+      puts "Body:#{body}"
       response = self.connection().post do |req|
         req.url rest_resource.class.resource_path
         add_headers req.headers
-        req.body = hash.to_json
+        req.body = body
+      end
+      if (response.env[:status] == 201)
+        location = response.env[:response_headers][:location]
+        id = location.gsub(/^.*\//, '')
+        rest_resource.id= id
+      else
+        puts "unable to create: #{response.env[:response_headers]} body: #{response.body} "
+        false
       end
-      location = response.env[:response_headers][:location]
-      id = location.gsub(/^.*\//, '')
-      rest_resource.id= id
-      response.env[:status] == 201
+      
     end
 
     def connection

data/lib/arrest/mem_source.rb

@@ -57,9 +57,15 @@ module Arrest
     end
 
 
+    def delete rest_resource
+      raise "To change an object it must have an id" unless rest_resource.respond_to?(:id) && rest_resource.id != nil
+      @@data[rest_resource.resource_path()].delete(rest_resource.id.to_s) 
+      rest_resource
+    end
+
     def put rest_resource
-      @@data[rest_resource.resource_path()][rest_resource.id.to_s] = rest_resource
       raise "To change an object it must have an id" unless rest_resource.respond_to?(:id) && rest_resource.id != nil
+      @@data[rest_resource.resource_path()][rest_resource.id.to_s] = rest_resource
       rest_resource
     end
 

data/lib/arrest/source.rb

@@ -4,6 +4,7 @@ module Arrest
     class << self
       attr_reader :source
       attr_reader :mod
+      attr_reader :header_decorator
 
       def source=(host=nil)
         if host == nil || host.blank?
@@ -24,7 +25,23 @@ module Arrest
         end
       end
 
+      def header_decorator=(hd=nil)
+        puts "Setting headerd to #{hd}"
+        if hd == nil
+          @header_decorator = self
+        elsif hd.respond_to?(:headers)
+          @header_decorator = hd
+        else
+          raise "Header_decorator must be an object that returns an hash for the method headers"
+        end
+      end
+
+      def headers
+        {}
+      end
+
     end
   end
   Source.mod = nil
+  Source.header_decorator = Source
 end

data/lib/arrest/string_utils.rb

@@ -0,0 +1,63 @@
+class StringUtils
+  class << self
+
+    PLURALS = [['(quiz)$', '\1zes'],['(ox)$', '\1en'],['([m|l])ouse$', '\1ice'],['(matr|vert|ind)ix|ex$', '\1ices'],
+      ['(x|ch|ss|sh)$', '\1es'],['([^aeiouy]|qu)ies$', '\1y'],['([^aeiouy]|q)y$$', '\1ies'],['(hive)$', '\1s'],
+      ['(?:[^f]fe|([lr])f)$', '\1\2ves'],['(sis)$', 'ses'],['([ti])um$', '\1a'],['(buffal|tomat)o$', '\1oes'],['(bu)s$', '\1es'],
+      ['(alias|status)$', '\1es'],['(octop|vir)us$', '\1i'],['(ax|test)is$', '\1es'],['s$', 's'],['$', 's']]
+    SINGULARS =[['(quiz)zes$', '\1'],['(matr)ices$', '\1ix'],['(vert|ind)ices$', '\1ex'],['^(ox)en$', '\1'],['(alias|status)es$', '\1'],
+      ['(octop|vir)i$', '\1us'],['(cris|ax|test)es$', '\1is'],['(shoe)s$', '\1'],['[o]es$', '\1'],['[bus]es$', '\1'],['([m|l])ice$', '\1ouse'],
+      ['(x|ch|ss|sh)es$', '\1'],['(m)ovies$', '\1ovie'],['[s]eries$', '\1eries'],['([^aeiouy]|qu)ies$', '\1y'],['[lr]ves$', '\1f'],
+      ['(tive)s$', '\1'],['(hive)s$', '\1'],['([^f])ves$', '\1fe'],['(^analy)ses$', '\1sis'],
+      ['([a]naly|[b]a|[d]iagno|[p]arenthe|[p]rogno|[s]ynop|[t]he)ses$', '\1\2sis'],['([ti])a$', '\1um'],['(news)$', '\1ews'], ['(.*)s$', '\1'], ['^(.*)$', '\1']]
+
+    def singular(str)
+      SINGULARS.each { |match_exp, replacement_exp| return str.gsub(Regexp.compile(match_exp), replacement_exp) unless str.match(Regexp.compile(match_exp)).nil?}
+    end
+
+    def plural(str)
+      PLURALS.each   { |match_exp, replacement_exp| return str.gsub(Regexp.compile(match_exp), replacement_exp) unless str.match(Regexp.compile(match_exp)).nil? }
+    end
+
+    def plural?
+      PLURALS.each {|match_exp, replacement_exp| return true if str.match(Regexp.compile(match_exp))}
+      false
+    end
+
+    def blank? str
+      str == nil || str == ""
+    end
+
+    def is_upper? str
+      str == str.upcase
+    end
+
+    def underscore str
+      word = str.to_s.dup
+      word.gsub!(/::/, '/')
+      word.gsub!(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
+      word.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
+      word.tr!("-", "_")
+      word.downcase!
+      word
+    end
+
+    def classify(str, upper_first = true)
+      result = ""
+      upperNext = false
+      (singular str) .each_char do |c|
+        if c == "_"
+          upperNext = true
+        else
+          if upperNext || (result == "" && upper_first)
+            result << c.upcase
+          else
+            result << c
+          end
+          upperNext = false
+        end
+      end
+      result
+    end
+  end
+end

data/lib/arrest/version.rb

@@ -1,3 +1,3 @@
 module Arrest
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/test/unit.rb

@@ -2,19 +2,19 @@ require 'arrest'
 require 'test/unit'
 
 class Zoo < Arrest::RootResource
-
   attributes :name
-
+  read_only_attributes :ro1
   has_many :animals
-
 end
 
 class Animal < Arrest::RestChild
-
   attributes :kind, :age
-
   parent :zoo
+end
 
+class SpecialZoo < Zoo
+  read_only_attributes :ro2
+  attributes :is_magic
 end
 
 class FirstTest < Test::Unit::TestCase
@@ -51,6 +51,25 @@ class FirstTest < Test::Unit::TestCase
     assert_equal new_zoo.name, zoo_reloaded.name
   end
 
+  def test_delete
+    zoo_count_before = Zoo.all.length
+    new_zoo = Zoo.new({:name => "Foo"})
+    new_zoo.save
+    zoo_count_after = Zoo.all.length
+
+    assert_equal (zoo_count_before + 1), zoo_count_after
+    assert new_zoo.id != nil
+
+    zoo_the_last = Zoo.all.last
+    assert_equal new_zoo.name, zoo_the_last.name
+
+    zoo_reloaded = Zoo.find(new_zoo.id)
+    assert_equal new_zoo.name, zoo_reloaded.name
+    
+    zoo_reloaded.delete
+    assert_equal zoo_count_before, Zoo.all.length
+  end
+
   def test_create_and_load
     zoo_count_before = Zoo.all.length
     new_zoo = Zoo.new({:name => "Foo"})
@@ -118,10 +137,49 @@ class FirstTest < Test::Unit::TestCase
 
     animal_retry = new_zoo.animals.last
     assert_equal animal_kind, animal_retry.kind
+  end
 
+  def test_inheritance
+    new_zoo = SpecialZoo.new({:name => "Foo", :is_magic => true})
+    new_zoo.save
 
+    assert new_zoo.id != nil, "Zoo must have id after save"
+    zoo_reloaded = SpecialZoo.find(new_zoo.id)
+    assert_equal true, zoo_reloaded.is_magic
+    assert_equal "Foo", zoo_reloaded.name
+  end
+
+  def test_inheritance_update
+    new_zoo = SpecialZoo.new({:name => "Foo", :is_magic => true})
+    new_zoo.save
+
+    assert new_zoo.id != nil, "Zoo must have id after save"
+    zoo_reloaded = SpecialZoo.find(new_zoo.id)
+    assert_equal true, zoo_reloaded.is_magic
+    assert_equal "Foo", zoo_reloaded.name
 
+    new_name = "Bar"
+    zoo_reloaded.name = new_name
+    zoo_reloaded.is_magic = !zoo_reloaded.is_magic
+    zoo_reloaded.save
+
+    updated_zoo = SpecialZoo.find(zoo_reloaded.id)
+    assert_equal new_name, updated_zoo.name
+    assert_equal !new_zoo.is_magic, updated_zoo.is_magic
   end
 
+  def test_read_only_attributes
+    zoo = SpecialZoo.new({:name => "Zoo", :ro1 => "one", :ro2 => "two", :is_magic => true})
+    
+    assert_equal "Zoo", zoo.name
+    assert_equal "one", zoo.ro1
+    assert_equal "two", zoo.ro2
+    assert_equal true, zoo.is_magic
+     
+    hash = zoo.to_hash
+
+    assert_nil hash[:ro1]
+    assert_nil hash[:ro2]
+  end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: arrest
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-07 00:00:00.000000000Z
+date: 2011-11-09 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &18515300 !ruby/object:Gem::Requirement
+  requirement: &2161032680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,18 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *18515300
+  version_requirements: *2161032680
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: &2161031520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 0.7.5
+  type: :runtime
+  prerelease: false
+  version_requirements: *2161031520
 description: Consume a rest API in a AR like fashion
 email:
 - axel.tetzlaff@fortytools.com
@@ -41,6 +52,7 @@ files:
 - lib/arrest/rest_child.rb
 - lib/arrest/root_resource.rb
 - lib/arrest/source.rb
+- lib/arrest/string_utils.rb
 - lib/arrest/version.rb
 - test/unit.rb
 homepage: ''
@@ -67,4 +79,5 @@ rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Another ruby rest client
-test_files: []
+test_files:
+- test/unit.rb