netilion 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2090933b33b832fc6a93f869d5faff0904a2f634063fe67ebfd5706f725a46b9
+  data.tar.gz: f0bcf8a0906fa4145ce714f949bccd8343056b5dee03709f7efe3b534572a630
+SHA512:
+  metadata.gz: 900dbdc7b592f872deecce38f7c88f32c73ef3d2f64e4d0962c7a9e13c4c7df614987bd07443d178f22166ed3c9377409200843543b846b8e5eec00d2994d61b
+  data.tar.gz: 3c52043925df5bdaaabfb41ea7cb966f10d0999a11434214a13fb2a8ffdb1e532a3723a0afbe4023bbcb7c5ff9cb353b746db3b087464ef3bca7c2c207e754ff

data/.github/workflows/ruby.yml

@@ -0,0 +1,22 @@
+name: Ruby
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [ '2.5', '2.6', '2.7' ]
+    name: Test Ruby ${{ matrix.ruby }}
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby ${{ matrix.ruby }}
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Build and test with Rake
+        run: |
+          gem install bundler
+          bundle install --jobs 4 --retry 3
+          bundle exec rake

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rubocop.yml

@@ -0,0 +1,74 @@
+AllCops:
+  Exclude:
+    - bin/*
+
+Documentation:
+  Enabled: false
+
+Layout/IndentationConsistency:
+  EnforcedStyle: indented_internal_methods
+
+Metrics/AbcSize:
+  Max: 200
+
+Metrics/LineLength:
+  Max: 180
+  Exclude:
+    - test/**/*
+
+Metrics/BlockLength:
+  Max: 100
+  Exclude:
+    - test/**/*
+
+Metrics/ClassLength:
+  Max: 300
+  Exclude:
+    - test/**/*
+
+Metrics/CyclomaticComplexity:
+  Max: 50
+
+Metrics/MethodLength:
+  Max: 100
+
+Metrics/ModuleLength:
+  Max: 300
+
+Metrics/ParameterLists:
+  Max: 10
+
+Metrics/PerceivedComplexity:
+  Max: 50
+
+Naming/VariableNumber:
+  Enabled: false
+
+Style/RedundantReturn:
+  Enabled: true
+  AllowMultipleReturnValues: true
+
+Style/Semicolon:
+  Enabled: true
+  AllowAsExpressionSeparator: true
+
+Style/SymbolArray:
+  EnforcedStyle: brackets
+
+Style/SymbolProc:
+  Enabled: false
+
+Style/ConditionalAssignment:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Lint/ParenthesesAsGroupedExpression:
+  Enabled: false
+
+Style/FormatStringToken:
+  EnforcedStyle: template

data/.ruby-version

@@ -0,0 +1 @@
+2.6.5

data/Gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Marco Roth
+
+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,155 @@
+# Netilion
+
+This is a Ruby Wrapper for the Netilion Information Hub API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'netilion'
+```
+
+And then execute:
+
+```ruby
+$ bundle
+```
+
+Or install it yourself as:
+
+```ruby
+$ gem install netilion
+```
+
+## Usage
+
+### Setup
+
+If you are using Rails you can setup the Netilion configuration for example in an initializer: `config/initializers/netilion.rb`
+
+```ruby
+Netilion.configure do |c|
+  c.environment = :production # accepts :production, :staging, :local
+  c.api_key = 'your-api-key'
+  c.username = 'test@example.org'
+  c.password = 'your-secret-password'
+end
+
+# or
+
+Netilion.config.environment = :production
+Netilion.config.api_key = 'your-api-key'
+Netilion.config.username = 'test@example.org'
+Netilion.config.password = 'your-secret-password'
+
+```
+
+### Querying Records
+
+Getting all records
+
+```ruby
+assets = Netilion::Asset.all
+
+assets.each do |asset|
+  puts asset.serial_number # => "123123123"
+  ...
+end
+
+puts assets.size # => 89
+```
+
+Filtering records
+
+```ruby
+assets = Netilion::Asset.where(serial_number: "123123123")
+puts assets.size # => 1
+```
+
+Getting an explicit record by id
+
+```ruby
+asset = Netilion::Asset.find(3204852)
+puts asset.serial_number # => "123123123"
+```
+
+Getting an explicit record by any attribute
+
+```ruby
+asset = Netilion::Asset.find_by(serial_number: "123123123")
+puts asset.serial_number # => "123123123"
+```
+
+Getting the first record
+
+```ruby
+asset = Netilion::Asset.first
+puts asset.serial_number # => "123123123"
+```
+
+Preload associations
+
+```ruby
+asset = Netilion::Asset.includes(:status).all.first
+puts asset.status.name # => "OK"
+```
+
+Load associations on demand
+
+```ruby
+asset = Netilion::Asset.first
+puts asset.status.load!.name # => "OK"
+```
+
+### Creating Records
+
+```ruby
+  Netilion::Asset.create(serial_number: "123123123", product: { id: "1" }, status: { id: "1" })
+```
+
+### Updating Records
+
+```ruby
+  asset = Netilion::Asset.last
+  asset.update({ description: "This is a new description" }, { method: :patch })
+```
+
+### Deleting Records
+
+```ruby
+  asset = Netilion::Asset.last
+  asset.destroy
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## TODO
+
+* [ ] Build all classes the api offers
+* [ ] Setup pagination in all classes
+* [ ] Setup all associations between the classes
+* [ ] Support the non-typical REST endpoints
+* [ ] Add validations for all classes
+* [ ] Proper error handling
+* [ ] Setup pagination and update method globally (probably in a `Netilion::Record` class and let all models inherit from it)
+* [ ] Support OAuth2
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/marcoroth/netilion.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Learn more
+* [Swagger Documentation](https://api.netilion.endress.com/doc/v1)
+* [Netilion Developer Platform](https://developer.netilion.endress.com)
+* [Netilion Connect](https://developer.netilion.endress.com/netilion-connect)
+* [Netilion Website](https://netilion.endress.com)

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'netilion'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require 'pry'
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/netilion.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'zeitwerk'
+require 'lhc'
+require 'lhs'
+
+inflections = {
+  'api_key' => 'APIKey',
+  'edm' => 'EDM'
+}
+
+loader = Zeitwerk::Loader.for_gem
+loader.enable_reloading
+loader.inflector.inflect(inflections)
+loader.setup
+
+module Netilion
+  Config = Struct.new :environment, :api_key, :username, :password
+
+  def self.configure(&config_block)
+    config_block.call config
+    set_api_placeholders
+    config
+  end
+
+  def self.config
+    @config ||= Config.new(environment: :production)
+  end
+
+  def self.api_base
+    case config.environment
+    when :production
+      'https://api.netilion.endress.com'
+    when :staging
+      'https://api.staging-env.netilion.endress.com'
+    when :local
+      'http://localhost:3000'
+    end
+  end
+
+  def self.set_api_placeholders
+    LHC.configure do |config|
+      config.placeholder(:api, "#{api_base}/v1")
+      config.placeholder(:edm, "#{api_base}/v1/edm")
+
+      config.interceptors = [
+        Authentication,
+        LHC::Auth,
+        LHC::Caching
+      ]
+    end
+  end
+end

data/lib/netilion/api_key.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Netilion
+  class APIKey < LHS::Record
+    configuration items_key: :api_keys
+
+    endpoint '{+api}/api_keys'
+    endpoint '{+api}/api_keys/{id}'
+
+    has_one :client_application, class_name: 'Netilion::ClientApplication'
+  end
+end

data/lib/netilion/api_subscription.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Netilion
+  class ApiSubscription < LHS::Record
+    configuration items_key: :api_subscriptions
+
+    endpoint '{+api}/api_subscriptions'
+    endpoint '{+api}/api_subscriptions/{id}'
+
+    has_one :user, class_name: 'Netilion::User'
+    has_one :client_application, class_name: 'Netilion::ClientApplication'
+  end
+end

data/lib/netilion/asset.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Netilion
+  class Asset < LHS::Record
+    configuration items_key: 'assets',
+                  pagination_strategy: :page,
+                  pagination_key: { body: %w[pagination page], parameter: 'page' },
+                  limit_key: { body: %w[pagination per_page], parameter: 'limit' },
+                  total_key: %w[pagination total_count]
+
+    endpoint '{+api}/assets'
+    endpoint '{+api}/assets/{id}'
+
+    has_one :status, class_name: 'Netilion::AssetStatus'
+    has_one :product, class_name: 'Netilion::Product'
+    has_one :tenant, class_name: 'Netilion::Tenant'
+  end
+end