figa 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0730264f5ad57b4adcf105062fa9aa2396710067
+  data.tar.gz: 882c6230a5d0b42cf50874f78904259f5ba5e820
+SHA512:
+  metadata.gz: ab01ea02cff6dc17a967b4b59e1ee1869b94b419df57ca0fb4090d9df7f3dc787bc66119a62c56726a536e4feec8b956a95388d26591f53345e06685b0ddad19
+  data.tar.gz: 625d7b5399b4cdf8ee8cabac46990ad147532a634ef8773c4f470c82bd1352b1ff79ee3efde46c01a25ba429f0257e750f98b01fc02d0ce5ba679410bbcea655

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+
+# CHANGELOG.md
+
+
+## sentofu 0.0.1  released 2019-06-13
+
+* Initial release
+

data/LICENSE.txt

@@ -0,0 +1,24 @@
+
+Copyright (c) 2019-2019, John Mettraux, jmettraux+flor@gmail.com
+
+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.
+
+
+Made in Japan
+

data/Makefile

@@ -0,0 +1,47 @@
+
+## gem tasks ##
+
+NAME = \
+  $(shell ruby -e "s = eval(File.read(Dir['*.gemspec'][0])); puts s.name")
+VERSION = \
+  $(shell ruby -e "s = eval(File.read(Dir['*.gemspec'][0])); puts s.version")
+
+count_lines:
+	find lib -name "*.rb" | xargs cat | ruby -e "p STDIN.readlines.count { |l| l = l.strip; l[0, 1] != '#' && l != '' }"
+	find spec -name "*_spec.rb" | xargs cat | ruby -e "p STDIN.readlines.count { |l| l = l.strip; l[0, 1] != '#' && l != '' }"
+cl: count_lines
+
+scan:
+	scan lib/**/*.rb
+
+gemspec_validate:
+	@echo "---"
+	ruby -e "s = eval(File.read(Dir['*.gemspec'].first)); p s.validate"
+	@echo "---"
+
+name: gemspec_validate
+	@echo "$(NAME) $(VERSION)"
+
+cw:
+	find lib -name "*.rb" -exec ruby -cw {} \;
+
+build: gemspec_validate
+	gem build $(NAME).gemspec
+	mkdir -p pkg
+	mv $(NAME)-$(VERSION).gem pkg/
+
+push: build
+	gem push pkg/$(NAME)-$(VERSION).gem
+
+spec:
+	bundle exec rspec
+test: spec
+
+
+## specific to project ##
+
+
+## done ##
+
+.PHONY: count_lines scan gemspec_validate name cw build push spec
+

data/README.md

@@ -0,0 +1,13 @@
+
+# figa
+
+A Ruby library to query [OpenFIGI](https://www.openfigi.com/) API v2.
+
+
+## usage
+
+
+## license
+
+MIT, see [LICENSE.txt](LICENSE.txt)
+

data/figa.gemspec

@@ -0,0 +1,47 @@
+
+Gem::Specification.new do |s|
+
+  s.name = 'figa'
+
+  s.version = File.read(
+    File.expand_path('../lib/figa.rb', __FILE__)
+  ).match(/ VERSION *= *['"]([^'"]+)/)[1]
+
+  s.platform = Gem::Platform::RUBY
+  s.authors = [ 'John Mettraux' ]
+  s.email = [ 'jmettraux@gmail.com' ]
+  s.homepage = 'http://github.com/jmettraux/figa'
+  s.license = 'MIT'
+  s.summary = 'A Ruby client to the OpenFIGI API v2'
+
+  s.description = %{
+A Ruby client to the OpenFIGI API v2.
+  }.strip
+
+  s.metadata = {
+    'changelog_uri' => s.homepage + '/blob/master/CHANGELOG.md',
+    'documentation_uri' => s.homepage,
+    'bug_tracker_uri' => s.homepage + '/issues',
+    #'mailing_list_uri' => 'https://groups.google.com/forum/#!forum/floraison',
+    'homepage_uri' =>  s.homepage,
+    'source_code_uri' => s.homepage,
+    #'wiki_uri' => s.homepage + '/wiki',
+  }
+
+  #s.files = `git ls-files`.split("\n")
+  s.files = Dir[
+    'README.{md,txt}',
+    'CHANGELOG.{md,txt}', 'CREDITS.{md,txt}', 'LICENSE.{md,txt}',
+    'Makefile',
+    'lib/**/*.rb', #'spec/**/*.rb', 'test/**/*.rb',
+    "#{s.name}.gemspec",
+  ]
+
+  #s.add_runtime_dependency 'raabro', '~> 1.1'
+  #s.add_runtime_dependency 'et-orbi', '~> 1.1', '>= 1.1.8'
+
+  s.add_development_dependency 'rspec', '~> 3.8'
+
+  s.require_path = 'lib'
+end
+

data/lib/figa.rb

@@ -0,0 +1,131 @@
+
+require 'json'
+require 'net/http'
+
+
+module Figa
+
+  VERSION = '0.0.1'
+
+  USER_AGENT = "Figa - https://github.com/jmettraux/figa - #{VERSION}"
+  API_ROOT_URI = 'https://api.openfigi.com/v2'
+
+  class Client
+
+    def initialize(api_key=nil)
+
+      @api_key = api_key
+      @enum_values = {}
+    end
+
+    def map(h)
+
+      k0 = h.is_a?(Hash) ? h.keys.first.to_s : nil
+
+      if k0 && h.size == 1 && enum_values('idType').include?(k0)
+
+        h = { idType: h.keys.first, idValue: h.values.first }
+      end
+
+      validate(h)
+
+      fail ArgumentError.new("parameter 'idType' is missing"
+        ) unless h[:idType] || h['idType']
+      fail ArgumentError.new("parameter 'idValue' is missing"
+        ) unless h[:idValue] || h['idValue']
+
+      post('/mapping', h)
+    end
+
+    def search(h)
+
+      h = { query: h } unless h.is_a?(Hash)
+
+      validate(h)
+
+      fail ArgumentError.new("parameter 'query' is missing"
+        ) unless h[:query] || h['query']
+
+      post('/search', h)
+    end
+
+    protected
+
+    ENUM_KEYS = %w[
+      idType exchCode micCode currency marketSecDes securityType securityType2 ]
+
+    def list_enum_values(key)
+
+      #fail ArgumentError.new(
+      #  "key #{key.inspect} not included in #{KEYS.inspect}"
+      #) unless KEYS.include?(key)
+
+      get('/mapping/values/' + key)
+    end
+
+    def enum_values(key)
+
+      @enum_values[key] ||= list_enum_values(key)
+    end
+
+    def validate(h)
+
+      h.each do |k, v|
+
+        sk = k.to_s
+        next unless ENUM_KEYS.include?(sk)
+
+        vs = (@enum_values[sk] ||= list_enum_values(key))
+
+        fail ArgumentError.new(
+          "value #{v.inspect} is not a valid value for key #{k.inspect}"
+        ) unless enum_values(keys).include?(v)
+      end
+    end
+
+    def get(uri); request(:get, uri); end
+    def post(uri, data); request(:post, uri, data); end
+
+    def request(method, uri, data=nil)
+
+      uri = API_ROOT_URI + uri
+
+      req = (method == :post ? Net::HTTP::Post : Net::HTTP::Get).new(uri)
+      req.instance_eval { @header.clear }
+      def req.set_header(k, v); @header[k] = [ v ]; end
+
+      if data
+        req.body = JSON.dump(data)
+        req.content_type = 'application/json'
+      end
+
+      req.set_header('User-Agent', USER_AGENT)
+      req.set_header('Accept', 'application/json')
+# TODO api key
+
+      u = URI(uri)
+
+      t0 = monow
+
+      t = Net::HTTP.new(u.host, u.port)
+      t.use_ssl = (u.scheme == 'https')
+#t.set_debug_output($stdout)
+#t.set_debug_output($stdout) if u.to_s.match(/search/)
+
+      res = t.request(req)
+
+      #class << res; attr_accessor :_elapsed; end
+      #res._elapsed = monow - t0
+
+      j = JSON.parse(res.body)
+      def j._response; res; end
+      j['_elapsed'] = monow - t0
+# TODO j['next']
+
+      j
+    end
+
+    def monow; Process.clock_gettime(Process::CLOCK_MONOTONIC); end
+  end
+end
+

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: figa
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- John Mettraux
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-06-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+description: A Ruby client to the OpenFIGI API v2.
+email:
+- jmettraux@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- Makefile
+- README.md
+- figa.gemspec
+- lib/figa.rb
+homepage: http://github.com/jmettraux/figa
+licenses:
+- MIT
+metadata:
+  changelog_uri: http://github.com/jmettraux/figa/blob/master/CHANGELOG.md
+  documentation_uri: http://github.com/jmettraux/figa
+  bug_tracker_uri: http://github.com/jmettraux/figa/issues
+  homepage_uri: http://github.com/jmettraux/figa
+  source_code_uri: http://github.com/jmettraux/figa
+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.5.2.3
+signing_key: 
+specification_version: 4
+summary: A Ruby client to the OpenFIGI API v2
+test_files: []