solovis_api_client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 68eb754f78feec7009b14eaa29c41cfa3ce8a986
+  data.tar.gz: 8f374a22f1e98c5a7268455b5ab0d31f578e5dcf
+SHA512:
+  metadata.gz: 57659fdd884c1a2956db02afcdcbc07e1a6105dee2d75d8f17a3f7e43fda2ce0d2a737d655fe0d6f2484030796eab26ea73bf489786a8c32b21ca64830038eb3
+  data.tar.gz: e4fefd2cff2dce7b9780579e89d145fd9521c55c2f13fa104311ae677b4b465bba5f26cd38798489b428aced0e7b24e3b630877f4a433e7c3a96be49463e34be

data/.circleci/config.yml

@@ -0,0 +1,72 @@
+# Ruby CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-ruby/ for more details
+#
+version: 2
+jobs:
+  build:
+    docker:
+       - image: circleci/ruby:2.4.1-node-browsers
+    working_directory: ~/solovis_api_client
+    steps:
+      - checkout
+      - restore_cache:
+          keys:
+          - v1-dependencies-{{ checksum "Gemfile.lock" }}
+          # fallback to using the latest cache if no exact match is found
+          - v1-dependencies-
+      - run:
+          name: Install Dependencies
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
+      - run:
+          name: Run Specs
+          command: |
+            mkdir /tmp/test-results
+            TEST_FILES="$(circleci tests glob "spec/**/*_spec.rb" | circleci tests split --split-by=timings)"
+
+            bundle exec rspec --format progress \
+                            --format RspecJunitFormatter \
+                            --out /tmp/test-results/rspec.xml \
+                            --format progress \
+                            $TEST_FILES
+      - store_test_results:
+          path: /tmp/test-results
+      - store_artifacts:
+          path: /tmp/test-results
+          destination: test-results
+  deploy:
+    docker:
+      - image: circleci/ruby:2.4.1-node-browsers
+    working_directory: ~/solovis_api_client
+    filters:
+      tags:
+        only: /.*/
+      branches:
+        ignore: /.*/
+    steps:
+      - checkout
+      - run:
+          name: Setup Rubygems
+          command: bash .circleci/setup-rubygems.sh
+
+      - run:
+          name: Publish to Rubygems
+          command: |
+            gem build solovis_api_client.gemspec
+            gem push "solovis_api_client-$(git describe --tags).gem"
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
+      - build
+      - deploy:
+          filters:
+            tags:
+              only: /.*/
+            branches:
+              ignore: /.*/

data/.circleci/setup-rubygems.sh

@@ -0,0 +1,3 @@
+mkdir ~/.gem
+echo -e "---\r\n:rubygems_api_key: $RUBYGEMS_API_KEY" > ~/.gem/credentials
+chmod 0600 /home/circleci/.gem/credentials

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in solovis_api_client.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,66 @@
+PATH
+  remote: .
+  specs:
+    solovis_api_client (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    coderay (1.1.2)
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
+    faraday (0.15.3)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.12.2)
+      faraday (>= 0.7.4, < 1.0)
+    i18n (1.1.1)
+      concurrent-ruby (~> 1.0)
+    jwt (2.1.0)
+    method_source (0.9.0)
+    minitest (5.11.3)
+    multipart-post (2.0.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rspec_junit_formatter (0.4.1)
+      rspec-core (>= 2, < 4, != 2.12.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport
+  bundler (~> 1.16)
+  faraday
+  faraday_middleware
+  jwt
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rspec_junit_formatter
+  solovis_api_client!
+
+BUNDLED WITH
+   1.16.6

data/README.md

@@ -0,0 +1,39 @@
+# SolovisApiClient
+
+An API client to communicate with the Solovis API.
+
+## Installation
+
+The SolovisApiClient gem is included in the [main Synap app](https://github.com/synap-collaboration/animated-ninja) (`animated-ninja`).
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'solovis_api_client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install solovis_api_client
+
+## Usage
+
+Create an API client by instantiating `SolovisApiClient::Base`, passing the Solovis environment's URL and a corresponding API key, formatted as `api_key__api_secret`
+
+```ruby
+  client = SolovisApiClient::Base.new(url: 'https://synap-demo.gateway.solovis.com', api_key: 'my-api-key__my-api-secret');
+```
+
+## 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).
+
+## Contributing
+
+Built by [Synap](https://www.getsynap.com)

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "solovis_api_client"
+
+# 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/solovis_api_client.rb

@@ -0,0 +1,11 @@
+require "solovis_api_client/version"
+require "solovis_api_client/base"
+require "solovis_api_client/site"
+require "solovis_api_client/connection"
+require "solovis_api_client/config"
+
+module SolovisApiClient
+  def self.config
+    SolovisApiClient::Config.instance
+  end
+end

data/lib/solovis_api_client/base.rb

@@ -0,0 +1,35 @@
+class SolovisApiClient::Base
+  attr_reader :site
+
+  def initialize(options = {})
+    config.add(:url, options[:url])
+    config.add(:api_key, options[:api_key])
+  end
+
+  def config
+    SolovisApiClient.config
+  end
+
+  def connection
+    SolovisApiClient::Connection.new.rpc_connection
+  end
+
+  def site
+    @site ||= SolovisApiClient::Site.new(self)
+  end
+
+  def rpc_invoke(uri_path, message)
+    response = connection.post do |req|
+      req.headers["Content-Type"] = "x-post-rpc/json"
+      req.headers["Content-Encoding"] = "utf-8"
+      req.url uri_path
+      req.body = message.to_json
+    end
+    body = response.body
+    if body["result"]
+      return body
+    elsif body["error"]
+      raise RuntimeError.new(body["error"])
+    end
+  end
+end

data/lib/solovis_api_client/config.rb

@@ -0,0 +1,23 @@
+require 'singleton'
+
+class SolovisApiClient::Config
+  include Singleton
+
+  attr_accessor :configs
+
+  def initialize
+    @configs = {}
+  end
+
+  def add(key, value)
+    @configs[key] = value
+  end
+
+  def url
+    @configs[:url]
+  end
+
+  def api_key
+    @configs[:api_key]
+  end
+end

data/lib/solovis_api_client/connection.rb

@@ -0,0 +1,40 @@
+require 'jwt'
+require 'faraday'
+require 'faraday_middleware'
+
+require 'active_support'
+require 'active_support/core_ext/numeric/time'
+
+class SolovisApiClient::Connection
+  def rpc_connection
+    Faraday.new(SolovisApiClient.config.url) do |conn|
+      conn.authorization :Bearer, bearer_token_jwt.to_s
+      conn.request :json
+      conn.response :json, :content_type => /\bjson$/
+
+      conn.adapter Faraday.default_adapter
+    end
+  end
+
+  private
+
+  def bearer_token_jwt
+    api_key_id, api_key_secret = SolovisApiClient.config.api_key.split("__", 2)
+    unless api_key_id && api_key_secret
+      raise "invalid api_key; must contain a __ to split"
+    end
+
+    not_before = Time.now
+    expires = not_before + 10.minutes
+    claims = {
+      'solovis-key-id' => api_key_id, # Solovis specific claim
+      'iss' => 'solovis-client',      # issuer claim
+      'aud' => 'solovis-platform',    # audience claim
+      'exp' => expires.to_i,          # expires
+      'nbf' => not_before.to_i,       # not-before
+    }
+
+    token = JWT.encode(claims, api_key_secret, 'HS256')
+    token
+  end
+end

data/lib/solovis_api_client/site.rb

@@ -0,0 +1,92 @@
+class SolovisApiClient::Site
+  attr_accessor :client, :model_environment
+
+  def initialize(client)
+    @client = client
+    populate
+  end
+
+  def set_value(property_definition_id, resource_id, new_value)
+    params = {
+      valuesToEdit: [
+        {
+          propertyDefinitionId: property_definition_id,
+          values: [new_value.to_s],
+          fromDayId: 0,
+          resourceId: resource_id
+        }
+      ]
+    }
+    client.rpc_invoke('/Rpc/PropertyEdit/SetValues', params)
+  end
+
+  def get_value(property_definition_id, resource_id)
+    fields_for_entity(resource_id)[property_definition_id]
+  end
+
+  private
+
+  def get_data_source(report, options)
+    client.rpc_invoke("/Rpc/DataSource/LoadDataSet", {path: report, options: options})
+  end
+
+  def fields_for_entity(resource_id = nil)
+    result = get_data_source('/Solovis/Metadata/ResourcePropertyValues', { resourceIdList: [resource_id] })
+    fields_hash = {}
+    result["result"]["dataSet"]["propertyValues"].each do |pv|
+      fields_hash[pv["propertyDefinitionId"]] = pv["valueStrings"]
+    end
+    fields_hash
+  end
+
+  def populate
+    @model_environment = get_data_source('/Solovis/Metadata/ModelEnvironment', model_environment_options).dig('result', 'dataSet', 'modelEnvironment')
+  end
+
+  def model_environment_options
+    {
+      #currencyOptions: {
+      #  loadAll: null , # System.Boolean */,
+      #  loadReferencedCurrencies: null , # System.Boolean */,
+      #  currencyIdsToLoad: [],
+      #  loadConnectedCurrencyPairs: null , # System.Boolean */
+      #},
+      #assetOptions: {
+      #  trueOwnerIds: [],
+      #  resourceIdsToLoad: []
+      #},
+      entityOptions: {
+        #entityIdsToLoad: [],
+        loadAll: true , # System.Boolean */,
+        #loadIfConnectedToLoadedInvestment: null , # System.Boolean */,
+        loadTrueOwners: true, # System.Boolean */,
+        includeLabel: true, # System.Boolean */,
+        includeCode: true, # System.Boolean */,
+        specialEntityDataOptions: {
+          includeAll: true, # System.Boolean */
+        }
+      },
+      investmentOptions: {
+        #investmentIdsToLoad: [],
+        #includeIfConnectedToEntityIds: [],
+        loadAll: true, # System.Boolean */,
+        includeLabel: true, # System.Boolean */,
+        includeCode: true, # System.Boolean */
+      },
+      #exposureProfileOptions: {
+      #  loadAll: null , # System.Boolean */
+      #},
+      propertyDefinitionOptions: {
+        #propertyDefinitionIdsToLoad: [],
+        #propertyDefinitionCodesToLoad: [],
+        loadAll: true, # System.Boolean */
+      },
+      tagSetOptions: {
+        #tagSetIdsToLoad: [],
+        #loadTagSetsForProperties: null , # System.Boolean */,
+        #loadTagSetsForExposureProfiles: null , # System.Boolean */,
+        loadAll: true, # System.Boolean */
+      }
+    }
+  end
+end

data/lib/solovis_api_client/version.rb

@@ -0,0 +1,3 @@
+module SolovisApiClient
+  VERSION = "0.1.0"
+end

data/solovis_api_client.gemspec

@@ -0,0 +1,34 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "solovis_api_client/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "solovis_api_client"
+  spec.version       = SolovisApiClient::VERSION
+  spec.authors       = ["Synap"]
+  spec.email         = ["ricardo@getsynap.com"]
+
+  spec.summary       = %q{A client to interact with Solovis's API, built for use with Synap}
+  spec.description   = %q{A client to interact with Solovis's API, built for use with Synap}
+  spec.homepage      = "https://getsynap.com"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "jwt"
+  spec.add_development_dependency "faraday"
+  spec.add_development_dependency "faraday_middleware"
+  spec.add_development_dependency "activesupport"
+  spec.add_development_dependency "rspec_junit_formatter"
+end

metadata

@@ -0,0 +1,186 @@
+--- !ruby/object:Gem::Specification
+name: solovis_api_client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Synap
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-10-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: jwt
+  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: faraday
+  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: faraday_middleware
+  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: activesupport
+  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: rspec_junit_formatter
+  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'
+description: A client to interact with Solovis's API, built for use with Synap
+email:
+- ricardo@getsynap.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".circleci/setup-rubygems.sh"
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/solovis_api_client.rb
+- lib/solovis_api_client/base.rb
+- lib/solovis_api_client/config.rb
+- lib/solovis_api_client/connection.rb
+- lib/solovis_api_client/site.rb
+- lib/solovis_api_client/version.rb
+- solovis_api_client.gemspec
+homepage: https://getsynap.com
+licenses: []
+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.13
+signing_key: 
+specification_version: 4
+summary: A client to interact with Solovis's API, built for use with Synap
+test_files: []