frodata 0.9.1

data/spec/frodata/usage_example_spec.rb

@@ -0,0 +1,188 @@
+require 'spec_helper'
+
+describe 'Usage examples', vcr: { cassette_name: 'usage_example_specs' } do
+  let(:service_url) { 'http://services.odata.org/V4/OData/OData.svc' }
+  let(:service) { FrOData::Service.new(service_url, name: 'ODataDemo') }
+
+  describe 'getting information' do
+    it 'returns the service URL' do
+      expect(service.service_url).to eq(service_url)
+    end
+
+    it 'returns the service namespace' do
+      expect(service.namespace).to eq('ODataDemo')
+    end
+
+    it 'lists entity types' do
+      expect(service.entity_types).to eq(%w[
+        ODataDemo.Product
+        ODataDemo.FeaturedProduct
+        ODataDemo.ProductDetail
+        ODataDemo.Category
+        ODataDemo.Supplier
+        ODataDemo.Person
+        ODataDemo.Customer
+        ODataDemo.Employee
+        ODataDemo.PersonDetail
+        ODataDemo.Advertisement
+      ])
+    end
+
+    it 'lists entity sets' do
+      expect(service.entity_sets).to eq({
+        "Products"       => "ODataDemo.Product",
+        "ProductDetails" => "ODataDemo.ProductDetail",
+        "Categories"     => "ODataDemo.Category",
+        "Suppliers"      => "ODataDemo.Supplier",
+        "Persons"        => "ODataDemo.Person",
+        "PersonDetails"  => "ODataDemo.PersonDetail",
+        "Advertisements" => "ODataDemo.Advertisement"
+      })
+    end
+  end
+
+  describe 'working with entity sets' do
+    it 'accessing entity sets' do
+      service.entity_sets.each do |entity_set_name, entity_name|
+        entity_set = service[entity_set_name]
+
+        expect(entity_set).to be_a(FrOData::EntitySet)
+        expect(entity_set.name).to eq(entity_set_name)
+        expect(entity_set.type).to eq(entity_name)
+        expect(entity_set.namespace).to eq(service.namespace)
+      end
+    end
+
+    describe 'accessing entities' do
+      let(:products) { service['Products'] }
+
+      it 'getting the first entity in a set' do
+        expect(products.first).to be_a(FrOData::Entity)
+        expect(products.first.name).to eq('Product')
+      end
+
+      it 'iterating over the entire set' do
+        products.each do |product|
+          expect(product).to be_a(FrOData::Entity)
+          expect(product.name).to eq('Product')
+        end
+      end
+
+      it 'counting entities' do
+        expect(products.count).to eq(11)
+      end
+
+      it 'creating a new entity' do
+        new_product = products.new_entity
+
+        expect(new_product).to be_a(FrOData::Entity)
+        expect(new_product.name).to eq('Product')
+      end
+    end
+
+    describe 'querying' do
+      let(:products) { service['Products'] }
+      let(:query)    { products.query }
+
+      it 'obtain a query object using #query' do
+        expect(products.query).to be_a(FrOData::Query)
+      end
+
+      it 'executing query' do
+        results = query.execute
+
+        expect(results.map { |p| p['Name']}).to eq([
+          "Bread",
+          "Milk",
+          "Vint soda",
+          "Havina Cola",
+          "Fruit Punch",
+          "Cranberry Juice",
+          "Pink Lemonade",
+          "DVD Player",
+          "LCD HDTV",
+          "Lemonade",
+          "Coffee"
+        ])
+      end
+
+      it 'adding criteria' do
+        query.where(query['Name'].eq('Milk'))
+        results = query.execute
+
+        expect(query.to_s).to eq("Products?$filter=Name eq 'Milk'")
+        results.each do |product|
+          expect(product).to be_a(FrOData::Entity)
+          expect(product.name).to eq('Product')
+          expect(product['Name']).to eq('Milk')
+        end
+      end
+
+      it 'ordering results' do
+        results = query.order_by('Name').execute
+
+        expect(results.map { |p| p['Name'] }).to eq([
+          "Bread",
+          "Coffee",
+          "Cranberry Juice",
+          "DVD Player",
+          "Fruit Punch",
+          "Havina Cola",
+          "LCD HDTV",
+          "Lemonade",
+          "Milk",
+          "Pink Lemonade",
+          "Vint soda"
+        ])
+      end
+
+      it 'returning query results in batches' do
+        batch_count = 0
+
+        query.in_batches(of: 5) do |batch|
+          expect(batch.count).to eq(5) unless batch_count == 2
+
+          batch.each do |entity|
+            expect(entity).to be_a(FrOData::Entity)
+            expect(entity.type).to eq('ODataDemo.Product')
+          end
+          batch_count += 1
+        end
+
+        expect(batch_count).to eq(3)
+      end
+    end
+  end
+
+  describe 'working with entities' do
+    let(:product) { service['Products'][1] }
+
+    it 'getting a list of property names' do
+      expect(product.property_names).to eq([
+        "ID", "Name", "Description", "ReleaseDate", "DiscontinuedDate", "Rating", "Price"
+      ])
+    end
+
+    it 'accessing entity properties' do
+      expect(product["ID"]).to eq(1)
+      expect(product["Name"]).to eq("Milk")
+      expect(product["Description"]).to eq("Low fat milk")
+      expect(product["ReleaseDate"]).to eq(DateTime.parse("1995-10-01T00:00:00Z"))
+      expect(product["DiscontinuedDate"]).to be_nil
+      expect(product["Rating"]).to eq(3)
+      expect(product["Price"]).to eq(3.5)
+    end
+  end
+
+  describe 'headers and authorization' do
+    it 'using HTTP Basic auth' do
+      service.connection.basic_auth('username', 'password')
+      expect(service['Products'][2]).to be_a(FrOData::Entity)
+    end
+
+    it 'using token auth' do
+      service.connection.authorization(:Bearer, 'token')
+      expect(service['Products'][3]).to be_a(FrOData::Entity)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,32 @@
+require 'frodata'
+require 'rspec/matchers' # required for 'equivalent-xml'
+require 'equivalent-xml'
+require 'securerandom'
+require 'timecop'
+
+# Load all files from `spec/support`
+Dir[File.dirname(__FILE__) + "/support/**/*.rb"].each {|f| require f }
+
+RSpec.configure do |config|
+  if config.files_to_run.one?
+    config.default_formatter = 'doc'
+  end
+
+  config.profile_examples = 3
+  config.order = :random
+
+  config.expect_with :rspec do |expectations|
+    expectations.syntax = :expect
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.syntax = :expect
+    mocks.verify_partial_doubles = true
+  end
+
+  config.after(:example) do
+    # We're calling this as a private method because there should not be any
+    # reasons to have to flush the service registry except in testing.
+    FrOData::ServiceRegistry.instance.send(:flush)
+  end
+end

data/spec/support/coverage.rb

@@ -0,0 +1,2 @@
+require 'simplecov'
+SimpleCov.start

data/spec/support/vcr.rb

@@ -0,0 +1,9 @@
+require 'vcr'
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/fixtures/vcr_cassettes'
+  c.hook_into :faraday
+  c.default_cassette_options = { record: :new_episodes }
+  c.debug_logger = File.open(ENV['VCR_LOG'], 'w') if ENV['VCR_LOG']
+  c.configure_rspec_metadata!
+end

metadata

@@ -0,0 +1,401 @@
+--- !ruby/object:Gem::Specification
+name: frodata
+version: !ruby/object:Gem::Version
+  version: 0.9.1
+platform: ruby
+authors:
+- Christoph Wagner
+- James Thompson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-05-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: rspec-autotest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: autotest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: equivalent-xml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: andand
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: Provides a simple interface for working with OData V4 APIs.
+email:
+- christoph@wrstudios.com
+- james@plainprograms.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".autotest"
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- TODO.md
+- frodata.gemspec
+- lib/frodata.rb
+- lib/frodata/entity.rb
+- lib/frodata/entity_container.rb
+- lib/frodata/entity_set.rb
+- lib/frodata/errors.rb
+- lib/frodata/navigation_property.rb
+- lib/frodata/navigation_property/proxy.rb
+- lib/frodata/properties.rb
+- lib/frodata/properties/binary.rb
+- lib/frodata/properties/boolean.rb
+- lib/frodata/properties/collection.rb
+- lib/frodata/properties/complex.rb
+- lib/frodata/properties/date.rb
+- lib/frodata/properties/date_time.rb
+- lib/frodata/properties/date_time_offset.rb
+- lib/frodata/properties/decimal.rb
+- lib/frodata/properties/enum.rb
+- lib/frodata/properties/float.rb
+- lib/frodata/properties/geography.rb
+- lib/frodata/properties/geography/base.rb
+- lib/frodata/properties/geography/line_string.rb
+- lib/frodata/properties/geography/point.rb
+- lib/frodata/properties/geography/polygon.rb
+- lib/frodata/properties/guid.rb
+- lib/frodata/properties/integer.rb
+- lib/frodata/properties/number.rb
+- lib/frodata/properties/string.rb
+- lib/frodata/properties/time.rb
+- lib/frodata/properties/time_of_day.rb
+- lib/frodata/property.rb
+- lib/frodata/property_registry.rb
+- lib/frodata/query.rb
+- lib/frodata/query/criteria.rb
+- lib/frodata/query/criteria/comparison_operators.rb
+- lib/frodata/query/criteria/date_functions.rb
+- lib/frodata/query/criteria/geography_functions.rb
+- lib/frodata/query/criteria/lambda_operators.rb
+- lib/frodata/query/criteria/string_functions.rb
+- lib/frodata/query/in_batches.rb
+- lib/frodata/railtie.rb
+- lib/frodata/schema.rb
+- lib/frodata/schema/complex_type.rb
+- lib/frodata/schema/enum_type.rb
+- lib/frodata/service.rb
+- lib/frodata/service/request.rb
+- lib/frodata/service/response.rb
+- lib/frodata/service/response/atom.rb
+- lib/frodata/service/response/json.rb
+- lib/frodata/service/response/plain.rb
+- lib/frodata/service/response/xml.rb
+- lib/frodata/service_registry.rb
+- lib/frodata/version.rb
+- spec/fixtures/files/entity_to_xml.xml
+- spec/fixtures/files/error.xml
+- spec/fixtures/files/metadata.xml
+- spec/fixtures/files/product_0.json
+- spec/fixtures/files/product_0.xml
+- spec/fixtures/files/products.json
+- spec/fixtures/files/products.xml
+- spec/fixtures/files/supplier_0.json
+- spec/fixtures/files/supplier_0.xml
+- spec/fixtures/vcr_cassettes/entity_set_specs.yml
+- spec/fixtures/vcr_cassettes/entity_set_specs/bad_entry.yml
+- spec/fixtures/vcr_cassettes/entity_set_specs/existing_entry.yml
+- spec/fixtures/vcr_cassettes/entity_set_specs/new_entry.yml
+- spec/fixtures/vcr_cassettes/entity_specs.yml
+- spec/fixtures/vcr_cassettes/navigation_property_proxy_specs.yml
+- spec/fixtures/vcr_cassettes/query/result_specs.yml
+- spec/fixtures/vcr_cassettes/query_specs.yml
+- spec/fixtures/vcr_cassettes/schema/complex_type_specs.yml
+- spec/fixtures/vcr_cassettes/service/request_specs.yml
+- spec/fixtures/vcr_cassettes/service_registry_specs.yml
+- spec/fixtures/vcr_cassettes/service_specs.yml
+- spec/fixtures/vcr_cassettes/usage_example_specs.yml
+- spec/frodata/entity/shared_examples.rb
+- spec/frodata/entity_container_spec.rb
+- spec/frodata/entity_set_spec.rb
+- spec/frodata/entity_spec.rb
+- spec/frodata/errors_spec.rb
+- spec/frodata/navigation_property/proxy_spec.rb
+- spec/frodata/navigation_property_spec.rb
+- spec/frodata/properties/binary_spec.rb
+- spec/frodata/properties/boolean_spec.rb
+- spec/frodata/properties/collection_spec.rb
+- spec/frodata/properties/date_spec.rb
+- spec/frodata/properties/date_time_offset_spec.rb
+- spec/frodata/properties/date_time_spec.rb
+- spec/frodata/properties/decimal_spec.rb
+- spec/frodata/properties/float_spec.rb
+- spec/frodata/properties/geography/line_string_spec.rb
+- spec/frodata/properties/geography/point_spec.rb
+- spec/frodata/properties/geography/polygon_spec.rb
+- spec/frodata/properties/geography/shared_examples.rb
+- spec/frodata/properties/guid_spec.rb
+- spec/frodata/properties/integer_spec.rb
+- spec/frodata/properties/string_spec.rb
+- spec/frodata/properties/time_of_day_spec.rb
+- spec/frodata/properties/time_spec.rb
+- spec/frodata/property_registry_spec.rb
+- spec/frodata/property_spec.rb
+- spec/frodata/query/criteria_spec.rb
+- spec/frodata/query_spec.rb
+- spec/frodata/schema/complex_type_spec.rb
+- spec/frodata/schema/enum_type_spec.rb
+- spec/frodata/schema_spec.rb
+- spec/frodata/service/request_spec.rb
+- spec/frodata/service/response_spec.rb
+- spec/frodata/service_registry_spec.rb
+- spec/frodata/service_spec.rb
+- spec/frodata/usage_example_spec.rb
+- spec/spec_helper.rb
+- spec/support/coverage.rb
+- spec/support/vcr.rb
+homepage: https://github.com/wrstudios/frodata
+licenses:
+- MIT
+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.6.14
+signing_key: 
+specification_version: 4
+summary: Simple OData library
+test_files:
+- spec/fixtures/files/entity_to_xml.xml
+- spec/fixtures/files/error.xml
+- spec/fixtures/files/metadata.xml
+- spec/fixtures/files/product_0.json
+- spec/fixtures/files/product_0.xml
+- spec/fixtures/files/products.json
+- spec/fixtures/files/products.xml
+- spec/fixtures/files/supplier_0.json
+- spec/fixtures/files/supplier_0.xml
+- spec/fixtures/vcr_cassettes/entity_set_specs.yml
+- spec/fixtures/vcr_cassettes/entity_set_specs/bad_entry.yml
+- spec/fixtures/vcr_cassettes/entity_set_specs/existing_entry.yml
+- spec/fixtures/vcr_cassettes/entity_set_specs/new_entry.yml
+- spec/fixtures/vcr_cassettes/entity_specs.yml
+- spec/fixtures/vcr_cassettes/navigation_property_proxy_specs.yml
+- spec/fixtures/vcr_cassettes/query/result_specs.yml
+- spec/fixtures/vcr_cassettes/query_specs.yml
+- spec/fixtures/vcr_cassettes/schema/complex_type_specs.yml
+- spec/fixtures/vcr_cassettes/service/request_specs.yml
+- spec/fixtures/vcr_cassettes/service_registry_specs.yml
+- spec/fixtures/vcr_cassettes/service_specs.yml
+- spec/fixtures/vcr_cassettes/usage_example_specs.yml
+- spec/frodata/entity/shared_examples.rb
+- spec/frodata/entity_container_spec.rb
+- spec/frodata/entity_set_spec.rb
+- spec/frodata/entity_spec.rb
+- spec/frodata/errors_spec.rb
+- spec/frodata/navigation_property/proxy_spec.rb
+- spec/frodata/navigation_property_spec.rb
+- spec/frodata/properties/binary_spec.rb
+- spec/frodata/properties/boolean_spec.rb
+- spec/frodata/properties/collection_spec.rb
+- spec/frodata/properties/date_spec.rb
+- spec/frodata/properties/date_time_offset_spec.rb
+- spec/frodata/properties/date_time_spec.rb
+- spec/frodata/properties/decimal_spec.rb
+- spec/frodata/properties/float_spec.rb
+- spec/frodata/properties/geography/line_string_spec.rb
+- spec/frodata/properties/geography/point_spec.rb
+- spec/frodata/properties/geography/polygon_spec.rb
+- spec/frodata/properties/geography/shared_examples.rb
+- spec/frodata/properties/guid_spec.rb
+- spec/frodata/properties/integer_spec.rb
+- spec/frodata/properties/string_spec.rb
+- spec/frodata/properties/time_of_day_spec.rb
+- spec/frodata/properties/time_spec.rb
+- spec/frodata/property_registry_spec.rb
+- spec/frodata/property_spec.rb
+- spec/frodata/query/criteria_spec.rb
+- spec/frodata/query_spec.rb
+- spec/frodata/schema/complex_type_spec.rb
+- spec/frodata/schema/enum_type_spec.rb
+- spec/frodata/schema_spec.rb
+- spec/frodata/service/request_spec.rb
+- spec/frodata/service/response_spec.rb
+- spec/frodata/service_registry_spec.rb
+- spec/frodata/service_spec.rb
+- spec/frodata/usage_example_spec.rb
+- spec/spec_helper.rb
+- spec/support/coverage.rb
+- spec/support/vcr.rb