odata4 0.7.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1a49a6ff012ef0bb66a692514d673479303e198b
+  data.tar.gz: 99cd07d3a97e6a972d81917949a2f4344745a735
+SHA512:
+  metadata.gz: f176202b1e8998dc076b21c33bcfde3ff95eb360cbff5fee4073aa9ba3d16334322c26801e3e3ed065101b7895b46bb418c4cddf21b3259f6663cff8f42c185c
+  data.tar.gz: b0a5b08aa206f1cf4baf90ecf7e2fe19002ae81bfae49b27d29523266ee13dde9ca01e7d1dfd3471572f4bdec61c9613d75f6b60ccfc6ccafab59647c49fd114

data/.autotest

@@ -0,0 +1,2 @@
+require 'autotest/bundler'
+

data/.gitignore

@@ -0,0 +1,24 @@
+*.gem
+*.rbc
+.bundle
+.config
+.idea
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+private

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.ruby-gemset

@@ -0,0 +1 @@
+odata

data/.ruby-version

@@ -0,0 +1 @@
+2.1

data/.travis.yml

@@ -0,0 +1,75 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - 2.1.1
+  - 2.1.2
+  - 2.1.3
+  - 2.1.4
+  - 2.1.5
+  - jruby
+  - jruby-head
+jdk:
+  - openjdk6
+  - openjdk7
+  - oraclejdk7
+  - oraclejdk8
+branches:
+  only:
+    - master
+matrix:
+  exclude:
+    - rvm: 1.9.3
+      jdk: openjdk6
+    - rvm: 1.9.3
+      jdk: oraclejdk7
+    - rvm: 1.9.3
+      jdk: oraclejdk8
+    - rvm: 2.0.0
+      jdk: openjdk6
+    - rvm: 2.0.0
+      jdk: oraclejdk7
+    - rvm: 2.0.0
+      jdk: oraclejdk8
+    - rvm: 2.1.0
+      jdk: openjdk6
+    - rvm: 2.1.0
+      jdk: oraclejdk7
+    - rvm: 2.1.0
+      jdk: oraclejdk8
+    - rvm: 2.1.1
+      jdk: openjdk6
+    - rvm: 2.1.1
+      jdk: oraclejdk7
+    - rvm: 2.1.1
+      jdk: oraclejdk8
+    - rvm: 2.1.2
+      jdk: openjdk6
+    - rvm: 2.1.2
+      jdk: oraclejdk7
+    - rvm: 2.1.2
+      jdk: oraclejdk8
+    - rvm: 2.1.3
+      jdk: openjdk6
+    - rvm: 2.1.3
+      jdk: oraclejdk7
+    - rvm: 2.1.3
+      jdk: oraclejdk8
+    - rvm: 2.1.4
+      jdk: openjdk6
+    - rvm: 2.1.4
+      jdk: oraclejdk7
+    - rvm: 2.1.4
+      jdk: oraclejdk8
+    - rvm: 2.1.5
+      jdk: openjdk6
+    - rvm: 2.1.5
+      jdk: oraclejdk7
+    - rvm: 2.1.5
+      jdk: oraclejdk8
+  allow_failures:
+    - rvm: jruby-head
+addons:
+  code_climate:
+    repo_token: 56e2763b5bfe138f566c5f2bf23c14deee4f8990324436dbde07ee2a34bb87f8

data/CHANGELOG.md

@@ -0,0 +1,120 @@
+# CHANGELOG
+
+## 0.7.0
+
+Major rewrite
+
+* Added support for OData 4.0
+* Dropped support for OData 3.0
+
+## 0.6.18
+
+* Minor internal fixes to OData::Query::Criteria.
+
+## 0.6.17
+
+* Added more graceful handling of manually passed advanced queries to
+  OData::Query::Criteria.
+
+## 0.6.16
+
+* Implemented OData::Query#empty? and fixed OData::Query#count.
+
+## 0.6.15
+
+* Fixed minor bug in last release.
+
+## 0.6.14
+
+* Changed implementation of OData::Association::Proxy#[] to properly handle
+  empty associations.
+
+## 0.6.13
+
+* Minor bug fix in OData::Query::Result#each implementation.
+
+## 0.6.12
+
+* Minor bug fix in OData::Query::Result#each implementation.
+
+## 0.6.11
+
+* Added logic to allow OData::Query::Result#each to handle paginated results.
+
+## 0.6.10
+
+* Changed how associations behave with mulitiplicity of one.
+
+## 0.6.9
+
+* Changed how OData::Entity#from_xml functions to better work with feed results.
+
+## 0.6.8
+
+* Added empty checking when checking for a nil value.
+
+## 0.6.7
+
+* Changed how commit failures are handled to use logging instead of raising an
+  error.
+* Added errors array to OData::Entity.
+
+## 0.6.6
+
+* Updated OData::EntitySet#setup_entity_post_request to properly format primary
+  key values when posting an entity.
+
+## 0.6.5
+
+* Fixed problem in OData::ComplexType#to_xml implementation.
+
+## 0.6.4
+
+* Added implementation of OData::ComplexType#type.
+
+## 0.6.3
+
+* Added OData::ComplexType#to_xml to make entity saving work correctly.
+
+## 0.6.1
+
+* Made a minor change to internals of OData::Query::Criteria.
+
+## 0.6.0
+
+* Added ability to handle associations in a reasonable way.
+
+## 0.5.1-8
+
+* Tons of changes throughout the code base
+
+## 0.5.0
+
+* Stopped using namespace from OData service as unique identifier in favor of
+  a supplied name option when opening a service.
+
+## 0.4.0
+
+* Added OData::Query#execute to run query and return a result.
+* Added OData::Query::Result to handle enumeration of query results.
+
+## 0.3.2
+
+* Refactored internals of the query interface.
+
+## 0.3.1
+
+* Resolved issues causing failure on Ruby 1.9 and JRuby.
+
+## 0.3.0
+
+* Removed dependency on ActiveSupport
+
+## 0.2.0
+
+* Added query interface for [System Query Options](http://www.odata.org/documentation/odata-version-3-0/odata-version-3-0-core-protocol#queryingcollections)
+* Refactored internal uses of System Query Options
+
+## 0.1.0
+
+* Core read/write behavior for OData v1-3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in odata.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,23 @@
+Copyright (c) 2018 Christoph Wagner <christoph@wrstudios.com>
+              2014 James Thompson   <james@plainprograms.com>
+
+MIT License
+
+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,287 @@
+# OData4
+
+The OData4 gem provides a simple wrapper around the OData Version 4.0 API protocol.
+It has the ability to automatically inspect compliant APIs and expose the relevant Ruby objects dynamically.
+It also provides a set of code generation tools for quickly bootstrapping more custom service libraries.
+
+**This gem supports [OData Version 4.0](http://www.odata.org/documentation/). Support for older versions is not a goal.**
+
+If you need a gem to integration with OData Version 3, you can use James Thompson's [original OData gem][ruby-odata], upon which this gem is based.
+
+[![Build Status](https://app.codeship.com/projects/da1eb540-ce3f-0135-2ddc-161d5c3cc5fd/status?branch=master)](https://app.codeship.com/projects/262148)
+[![Maintainability](https://api.codeclimate.com/v1/badges/f151944dc05b2c7268e5/maintainability)](https://codeclimate.com/github/wrstudios/odata4/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/f151944dc05b2c7268e5/test_coverage)](https://codeclimate.com/github/wrstudios/odata4/test_coverage)
+[![Dependency Status](https://gemnasium.com/badges/github.com/wrstudios/odata4.svg)](https://gemnasium.com/github.com/wrstudios/odata4)
+[![Documentation](http://inch-ci.org/github/wrstudios/odata4.png?branch=master)](http://www.rubydoc.info/github/wrstudios/odata4/master)
+
+## Installation
+
+Add this line to your application's `Gemfile`:
+
+    gem 'odata4', git: 'https://github.com/wrstudios/odata4'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install odata4
+
+## Usage
+
+### Services & the Service Registry
+
+The OData4 gem provides a number of core classes, the two most basic ones are the `OData4::Service` and the `OData4::ServiceRegistry`.
+The only time you will need to worry about the `OData4::ServiceRegistry` is when you have multiple OData4
+services you are interacting with that you want to keep straight easily.
+The nice thing about `OData4::Service` is that it automatically registers with the registry on creation, so there is no manual interaction with the registry necessary.
+
+To create an `OData4::Service` simply provide the location of a service endpoint to it like this:
+
+```ruby
+  OData4::Service.open('http://services.odata.org/V4/OData/OData.service')
+```
+
+You may also provide an options hash after the URL.
+It is suggested that you supply a name for the service via this hash like so:
+
+```ruby
+  OData4::Service.open('http://services.odata.org/V4/OData/OData.service', name: 'ODataDemo')
+```
+
+This one call will setup the service and allow for the discovery of everything the other parts of the OData4 gem need to function.
+The two methods you will want to remember from `OData4::Service` are `#service_url` and `#name`.
+Both of these methods are available on instances and will allow for lookup in the `OData4::ServiceRegistry`, should you need it.
+
+Using either the service URL or the name provided as an option when creating an `OData4::Service` will allow for quick lookup in the `OData4::ServiceRegistry` like such:
+
+```ruby
+  OData4::ServiceRegistry['http://services.odata.org/V4/OData/OData.service']
+  OData4::ServiceRegistry['ODataDemo']
+```
+
+Both of the above calls would retrieve the same service from the registry.
+At the moment there is no protection against name collisions provided in `OData4::ServiceRegistry`.
+So, looking up services by their service URL is the most exact method, but lookup by name is provided for convenience.
+
+### Authentication
+
+When authenticating with your service you can set parameters to the Typhoeus gem which uses libcurl.
+Use the **:typhoeus** option to set your authentication.
+
+For example using **ntlm** authentication:
+
+```ruby
+  conn = OData4::Service.open('http://services.odata.org/V4/OData/OData.service', {
+    name: 'ODataDemo',
+    typhoeus: {
+      username: 'username',
+      password: 'password',
+      httpauth: :ntlm
+    }
+  })
+```
+
+For more authentication options see [libcurl][libcurl] or [typhoeus][typhoeus].
+
+[libcurl]: http://curl.haxx.se/libcurl/c/CURLOPT_HTTPAUTH.html
+[typhoeus]: https://github.com/typhoeus/typhoeus
+
+### Metadata File
+
+Typically the metadata file of a service can be quite large.
+You can speed your load time by forcing the service to load the metadata from a file rather than a URL.
+This is only recommended for testing purposes, as the metadata file can change.
+
+```ruby
+  conn = OData4::Service.open('http://services.odata.org/V4/OData/OData.service', {
+      name: 'ODataDemo',
+      metadata_file: "metadata.xml",
+  })
+```
+
+### Headers
+
+You can set the headers with the **:typhoeus** param like so:
+
+```ruby
+  conn = OData4::Service.open('http://services.odata.org/V4/OData/OData.service', {
+    name: 'ODataDemo',
+    typhoeus: {
+      headers: {
+        "Authorization" => "Bearer #{token}"
+      }
+    }
+  })
+```
+
+### Entity Sets
+
+When it comes to reading data from an OData4 service the most typical way will be via `OData4::EntitySet` instances.
+Under normal circumstances you should never need to worry about an `OData4::EntitySet` directly.
+For example, to get an `OData4::EntitySet` for the products in the ODataDemo service simply access the entity set through the service like this:
+
+```ruby
+  service = OData4::Service.open('http://services.odata.org/V4/OData/OData.service')
+  products = service['ProductsSet'] # => OData4::EntitySet
+```
+
+`OData4::EntitySet` instances implement the `Enumerable` module, meaning you can work with them very naturally, like this:
+
+```ruby
+  products.each do |entity|
+    entity # => OData4::Entity for type Product
+  end
+```
+
+You can get a list of all your entity sets like this:
+
+```ruby
+  service.entity_sets
+```
+
+#### Count
+Some versions of Microsoft CRM do not support count.
+
+```ruby
+  products.count
+```
+
+#### Collections
+You can you the following methods to grab a collection of Entities:
+
+```ruby
+  products.each do |entity|
+    ...
+  end
+```
+
+The first entity object returns a single entity object.
+
+```ruby
+  products.first
+```
+
+`first(x)` returns an array of entity objects.
+
+```ruby
+  products.first(x)
+```
+
+#### Find a certain Entity
+
+```ruby
+  service['ProductsSet']['<guid of entity>']
+```
+
+With certain navigation properties expanded (i.e. eagerly loaded):
+
+```ruby
+  # Eagerly load a single navigation property
+  service['ProductsSet', expand: 'Categories']
+
+  # Eagerly load multiple navigation properties
+  service['ProductsSet', expand: ['Categories', 'Supplier']]
+
+  # Eagerly load ALL navigation properties
+  service['ProductsSet', expand: :all]
+```
+
+### Entities
+
+`OData4::Entity` instances represent individual entities, or records, in a given service.
+They are returned primarily through interaction with instances of `OData4::EntitySet`.
+You can access individual properties on an `OData4::Entity` like so:
+
+```ruby
+  product = products.first # => OData4::Entity
+  product['Name']  # => 'Bread'
+  product['Price'] # => 2.5 (Float)
+```
+
+Individual properties on an `OData4::Entity` are automatically typecast by the gem, so you don't have to worry about too much when working with entities.
+The way this is implemented internally guarantees that an `OData4::Entity` is always ready to save back to the service or `OData4::EntitySet`, which you do like so:
+
+```ruby
+  service['Products'] << product # Write back to the service
+  products << product        # Write back to the Entity Set
+```
+
+You can get a list of all your entities like this:
+
+```ruby
+  service.entity_types
+```
+
+#### Entity Properties
+Reading, parsing and instantiating all properties of an entity can add up to a significant amount of time, particularly for those entities with a large number of properties.
+To speed this process up all properties are lazy loaded.
+Which means it will store the name of the property, but will not parse and instantiate the property until you want to use it.
+
+You can find all the property names of your entity with
+
+```ruby
+  product.property_names
+```
+
+You can grab the parsed value of the property as follows:
+
+```ruby
+  product["Name"]
+```
+
+or, you can get a hold of the property class instance using
+
+```ruby
+  product.get_property("Name")
+```
+
+This will parse and instantiate the property if it hasn't done so yet.
+
+### Queries
+
+`OData4::Query` instances form the base for finding specific entities within an `OData4::EntitySet`.
+A query object exposes a number of capabilities based on
+the [System Query Options](http://docs.oasis-open.org/odata/odata/v4.0/errata03/os/complete/part1-protocol/odata-v4.0-errata03-os-part1-protocol-complete.html#_Toc453752288) provided for in the OData V4.0 specification.
+Below is just a partial example of what is possible:
+
+```ruby
+  query = service['Products'].query
+  query.where(query[:Price].lt(15))
+  query.where(query[:Rating].gt(3))
+  query.limit(3)
+  query.skip(2)
+  query.order_by("Name")
+  query.select("Name,CreatedBy")
+  query.inline_count
+  results = query.execute
+  results.each {|product| puts product['Name']}
+```
+
+The process of querying is kept purposely verbose to allow for lazy behavior to be implemented at higher layers.
+Internally, `OData4::Query` relies on the `OData4::Query::Criteria` for the way the `where` method works.
+You should refer to the published RubyDocs for full details on the various capabilities:
+
+ * [OData4::Query](http://rubydoc.info/github/wrstudios/odata4/master/OData4/Query)
+ * [OData4::Query::Criteria](http://rubydoc.info/github/wrstudios/odata4/master/OData4/Query/Criteria)
+
+## Contributing
+
+1. Fork it (`https://github.com/[my-github-username]/odata/fork`)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## Credits
+
+Many thanks go to [James Thompson][@plainprogrammer], who wrote the [original OData (Version 3.0) gem][ruby-odata].
+
+[@plainprogrammer]: https://github.com/plainprogrammer
+[ruby-odata]: https://github.com/ruby-odata/odata
+
+Also, I would like to thank [W+R Studios][wrstudios] for generously allowing me to work on Open Source software like this. If you want to work on interesting challenges with an awesome team, check out our [open positions][wrcareers].
+
+[wrstudios]: http://wrstudios.com/
+[wrcareers]: http://wrstudios.com/careers