odata 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4d4292a0e518b0b7733528f80c2b5c2e9097fc80
-  data.tar.gz: ca790d90d9beb0d6deac504ec66bc563621a5fee
+  metadata.gz: 1e5c0770f691489dde6cbba87e2414dd75a1aa88
+  data.tar.gz: cfe4aecd0925e4301b0d031ae3f8119d169af98f
 SHA512:
-  metadata.gz: af023f47d0d372cf7c3c85cc0cdaef18eca711381e22dd3aa2ebf222b26b4faef3fc6a3d522307dc3577e863fd366d212c749d201157ae28ba1f1307e299a5a7
-  data.tar.gz: e5837bc7f3a012fd7c94c66f7d9774e90e684f0a7f3d1be93e96c8d0a8e489cb548e4d6f4b4ca9e2ae9dfe9ba0752636a8052c7ede9b00d2b716c85d3d701cc3
+  metadata.gz: 0008e948c633b04d6d8609796bcd3262e53ccb8ed82a75754d1edca84e153d0c04371fc695eee7b2e97d77715ea0dbc432eeb52bb533f232e6bb0466d8cf66fc
+  data.tar.gz: 23a3a1ca3bbf5dc67fc79fb15ec48512fd89dc84d7bcfb6cf54c37f3704b03b9c62b8e40dec95de1a8156b050e8f9413e96eb091fd123d2d010613bd89e2731e

data/README.md

@@ -4,6 +4,7 @@
 [![Code Climate](https://codeclimate.com/github/plainprogrammer/odata.png)](https://codeclimate.com/github/plainprogrammer/odata)
 [![Coverage](https://codeclimate.com/github/plainprogrammer/odata/coverage.png)](https://codeclimate.com/github/plainprogrammer/odata)
 [![Gem Version](https://badge.fury.io/rb/odata.svg)](http://badge.fury.io/rb/odata)
+[![Documentation](http://inch-ci.org/github/plainprogrammer/odata.png?branch=master)](http://rubydoc.info/github/plainprogrammer/odata/master/frames)
 
 The OData gem provides a simple wrapper around the OData API protocol. It has
 the ability to automatically inspect compliant APIs and expose the relevant

data/lib/odata/model.rb

@@ -1,4 +1,12 @@
 module OData
+  # Provides a convenient way to represent OData entities as Ruby objects.
+  # Instances that include this module gain the ability to define how to map
+  # OData properties to attributes as well as the ability to query and persist
+  # data to the underlying OData service.
+  #
+  # If the module detects the presence of Rails, along with ActiveModel::Model
+  # it will automatically mixin support ActiveModel::Model to provide better
+  # integration with Rails apps.
   module Model
     extend ::ActiveSupport::Concern
     include ::ActiveModel::Model if defined?(::Rails) && defined?(::ActiveModel::Model)
@@ -13,17 +21,49 @@ module OData
       EOS
     end
 
+    def convert_value_for_type(value, type)
+      return nil if value.nil? || type.nil?
+      if type =~ /Int(16|32|64)$/
+        value.to_i
+      elsif type =~ /Boolean$/
+        (value == 'true' || value == '1')
+      elsif type =~ /(Decimal|Double|Single)$/
+        value.to_f
+      elsif type =~ /DateTime$/
+        DateTime.parse(value)
+      else
+        value.to_s
+      end
+    end
+
     module ClassMethods
+      # Returns the class' name
       def model_name
         self.to_s.demodulize
       end
 
+      # Pluralizes #model_name for OData requests
       def odata_name
         model_name.pluralize
       end
 
+      def load_from_feed(feed_hash)
+        loaded_instance = self.new
+        feed_hash.each do |attribute_name, details|
+          loaded_instance.instance_eval do
+            @properties ||= {}
+            @properties[attribute_name] = convert_value_for_type(details[:value], details[:type])
+          end
+        end
+        loaded_instance
+      end
+
+      # Define a property and it's options
+      #
+      # @param name [to_s] the literal property name expected by the OData service
+      # @param options [Hash] options for setting up the property
       def property(name, options = {})
-        register_property(name.to_s.underscore, options.merge(literal_name: name))
+        register_property(name.to_s.underscore, {literal_name: name}.merge(options))
         create_accessors(name.to_s.underscore, options)
         register_primary_key(name.to_s.underscore) if options[:primary_key]
       end
@@ -38,8 +78,16 @@ module OData
 
       def create_accessors(name, options)
         self.class_eval do
-          define_method(name) { @properties[name.to_sym] || nil }
-          define_method("#{name}=") {|value| @properties[name.to_sym] = value}
+          if options[:entity_title]
+            define_method(name) { @properties[:title] || nil }
+            define_method("#{name}=") {|value| @properties[:title] = value}
+          elsif options[:entity_summary]
+            define_method(name) { @properties[:summary] || nil }
+            define_method("#{name}=") {|value| @properties[:summary] = value}
+          else
+            define_method(name) { @properties[name.to_sym] || nil }
+            define_method("#{name}=") {|value| @properties[name.to_sym] = value}
+          end
         end
       end
 

data/lib/odata/service.rb

@@ -1,33 +1,55 @@
 module OData
+  # Encapsulates the basic details and functionality needed to interact with an
+  # OData service.
   class Service
+    # The OData Service's URL
     attr_reader :service_url
 
+    # Opens the service based on the requested URL and adds the service to
+    # {OData::Registry}
+    #
+    # @param service_url [String] the URL to the desired OData service
+    # @return [OData::Service] an instance of the service
     def initialize(service_url)
       @service_url = service_url
       OData::ServiceRegistry.add(self)
       self
     end
 
+    # Opens the service based on the requested URL and adds the service to
+    # {OData::Registry}
+    #
+    # @param service_url [String] the URL to the desired OData service
+    # @return [OData::Service] an instance of the service
     def self.open(service_url)
       Service.new(service_url)
     end
 
+    # Returns a list of entities exposed by the service
     def entities
       @entities ||= metadata.xpath('//EntityType').collect {|entity| entity.attributes['Name'].value}
     end
 
+    # Returns a list of ComplexTypes used by the service
     def complex_types
       @complex_types ||= metadata.xpath('//ComplexType').collect {|entity| entity.attributes['Name'].value}
     end
 
+    # Returns the namespace defined on the service's schema
     def namespace
       @namespace ||= metadata.xpath('//Schema').first.attributes['Namespace'].value
     end
 
+    # Returns a more compact inspection of the service object
     def inspect
       "#<#{self.class.name}:#{self.object_id} namespace='#{self.namespace}' service_url='#{self.service_url}'>"
     end
 
+    # Handles getting OData resources from the service.
+    #
+    # @param model [OData::Model] the type of resource being requested
+    # @param criteria [Hash] any criteria to narrow the request
+    # @return [Array] instances of the requested model
     def get(model, criteria = {})
       request = ::Typhoeus::Request.new(
           build_request_url(model, criteria),
@@ -36,7 +58,7 @@ module OData
       request.run
       response = request.response
       feed = ::Nokogiri::XML(response.body).remove_namespaces!
-      feed.xpath('//entry')
+      feed.xpath('//entry').collect {|entry| parse_model_from_feed(model, entry)}
     end
 
     private
@@ -58,5 +80,38 @@ module OData
       request_url += "(#{criteria[:key]})" if criteria[:key]
       request_url
     end
+
+    def parse_model_from_feed(model, entry)
+      attributes = {}
+
+      attributes[:title] = {
+          value: entry.xpath('//title').first.content,
+          type: entry.xpath('//title').first.attributes['type'].value
+      }
+
+      attributes[:summary] = {
+          value: entry.xpath('//summary').first.content,
+          type: entry.xpath('//summary').first.attributes['type'].value
+      }
+
+      entry.xpath('//content/properties/*').each do |property|
+        if property.attributes['null']
+          if property.attributes['null'].value == 'true'
+            property_type = nil
+          else
+            property_type = property.attributes['type'].value
+          end
+        else
+          property_type = property.attributes['type'].value
+        end
+
+        attributes[property.name.underscore.to_sym] = {
+            value: property.content,
+            type: property_type
+        }
+      end
+
+      model.load_from_feed(attributes)
+    end
   end
 end

data/lib/odata/service_registry.rb

@@ -1,9 +1,13 @@
 require 'singleton'
 
 module OData
+  # Provides a registry for keeping track of multiple OData::Service instances
   class ServiceRegistry
     include Singleton
 
+    # Add a service to the Registry
+    #
+    # @param service [OData::Service] service to add to the registry
     def add(service)
       initialize_instance_variables
       @services << service if service.is_a?(OData::Service) && !@services.include?(service)
@@ -11,16 +15,22 @@ module OData
       @services_by_url[service.service_url] = @services.find_index(service)
     end
 
+    # Lookup a service by URL or namespace
+    #
+    # @param lookup_key [String] the URL or namespace to lookup
+    # @return [OData::Service, nil] the OData::Service or nil
     def [](lookup_key)
       initialize_instance_variables
       index = @services_by_namespace[lookup_key] || @services_by_url[lookup_key]
       index.nil? ? nil : @services[index]
     end
 
+    # (see #add)
     def self.add(service)
       OData::ServiceRegistry.instance.add(service)
     end
 
+    # (see #[])
     def self.[](lookup_key)
       OData::ServiceRegistry.instance[lookup_key]
     end

data/lib/odata/version.rb

@@ -1,3 +1,3 @@
 module OData
-  VERSION = '0.0.6'
+  VERSION = '0.0.7'
 end

data/lib/odata.rb

@@ -1,3 +1,4 @@
+require 'date'
 require 'nokogiri'
 require 'typhoeus'
 

data/spec/examples/product_model.rb

@@ -3,8 +3,8 @@ module Examples
     include OData::Model
 
     property 'ID', primary_key: true
-    property 'Name'
-    property 'Description'
+    property 'Name', entity_title: true
+    property 'Description', entity_summary: true
     property 'ReleaseDate'
     property 'DiscontinuedDate'
     property 'Rating'

data/spec/odata/service_spec.rb

@@ -51,7 +51,23 @@ describe OData::Service do
   end
 
   describe '#get' do
-    it { expect(subject.get(::Examples::Product).size).to eq(11) }
-    it { expect(subject.get(::Examples::Product, {key: 0}).size).to eq(1) }
+    describe 'a set of entities' do
+      it { expect(subject.get(::Examples::Product).size).to eq(11) }
+      it { expect(subject.get(::Examples::Product).first).to be_instance_of(::Examples::Product) }
+      it { expect(subject.get(::Examples::Product).shuffle.first).to be_instance_of(::Examples::Product) }
+      it { expect(subject.get(::Examples::Product).last).to be_instance_of(::Examples::Product) }
+    end
+
+    describe 'a specific entity by key' do
+      it { expect(subject.get(::Examples::Product, {key: 0}).size).to eq(1) }
+      it { expect(subject.get(::Examples::Product, {key: 0}).first).to be_instance_of(::Examples::Product) }
+      it { expect(subject.get(::Examples::Product, {key: 0}).first.id).to eq(0) }
+      it { expect(subject.get(::Examples::Product, {key: 0}).first.name).to eq('Bread') }
+      it { expect(subject.get(::Examples::Product, {key: 0}).first.description).to eq('Whole grain bread') }
+      it { expect(subject.get(::Examples::Product, {key: 0}).first.release_date).to eq(DateTime.parse('1992-01-01T00:00:00')) }
+      it { expect(subject.get(::Examples::Product, {key: 0}).first.discontinued_date).to eq(nil) }
+      it { expect(subject.get(::Examples::Product, {key: 0}).first.rating).to eq(4) }
+      it { expect(subject.get(::Examples::Product, {key: 0}).first.price).to eq(2.5) }
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: odata
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - James Thompson