datagun 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b4ac265206ad2704dcf0da532304b78bbd7c54e698a5dacafb479a73fc994c25
+  data.tar.gz: ecd9c1eab8dc5c381666bcce2b9f544391f713f4941fd906b83147a8720370bb
+SHA512:
+  metadata.gz: 60694b67a8035293064a8c75226a4d1e9d3980ba2ef1e3d167c53365cef34fd976a912a3388a87e1ffc3aef9fc7e478e3a1601290ac3fb389f2719696e3d0808
+  data.tar.gz: ca0220d10670169929fa5e2406f2b3ff260ee545e911285dcb862b60ec3f7f029f144a3cb9e349637a3b1bacd3ea56df227dad9913abe37ac21ec4ebf2cab6dd

data/.gitignore

@@ -0,0 +1,2 @@
+.byebug_history
+.rspec_status

data/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+2.7.0

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+cache: bundler
+
+rvm:
+  - 2.6.5
+  - 2.7.0
+
+script:
+  - bundle exec rake spec
+

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in datagun.gemspec
+gemspec
+
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'
+gem 'rubocop', '~> 0.82.0'
+gem 'byebug', '~> 11.1.2'

data/Gemfile.lock

@@ -0,0 +1,72 @@
+PATH
+  remote: .
+  specs:
+    datagun (0.1.0)
+      rest-client (~> 2.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    byebug (11.1.2)
+    diff-lcs (1.3)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    http-accept (1.7.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    jaro_winkler (1.5.4)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2019.1009)
+    netrc (0.11.0)
+    parallel (1.19.1)
+    parser (2.7.1.1)
+      ast (~> 2.4.0)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    rest-client (2.1.0)
+      http-accept (>= 1.7.0, < 2.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    rubocop (0.82.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rexml
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    ruby-progressbar (1.10.1)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.7)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byebug (~> 11.1.2)
+  datagun!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.82.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Duccio Giovannelli
+
+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,86 @@
+# Datagun
+
+[![Build Status](https://travis-ci.org/4forges/datagun.svg?branch=master)](https://travis-ci.org/4forges/datagun)
+
+A Ruby interface to the Datagun API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'datagun'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install datagun
+
+## Usage
+
+```ruby
+  Datagun.configure do |config|
+    config.api_key = 'token'
+    config.api_version = 'v1'
+  end
+```
+
+### Top keywords
+
+Define a client and you gen upload your corpus. You can list your models, check a single model status, delete a model and analyze your text.
+
+```ruby
+  client = Datagun::Api::KeywordsExtractor::Client.new
+
+  client.save_model(name: 'italian', file: File.open('/Users/giovannelli/Desktop/models/it.csv'))
+  # list models
+  client.models
+
+  # Get model status
+  # model statuse: processin, ready, failed
+  client.status(model_id: "model id")
+
+  # Delete a model
+  client.delete(model_id: "model id")
+
+  # analyze your text getting keywords with scores
+  client.analyze(text: "lorem ispum dolor sic amet", model_id: "model id")
+```
+
+### Community Detection
+
+Define a client call detect
+
+```ruby
+  client = Datagun::Api::KeywordsExtractor::Client.new
+
+  # Return a list of communities
+  client.detect(graph: 'json')
+```
+
+### Image hash
+
+Define a client and call perceptual
+
+```ruby
+  client = Datagun::Api::KeywordsExtractor::Client.new
+
+  # Return a list of communities
+  client.perceptual(url: 'https://upload.wikimedia.org/wikipedia/commons/thumb/7/73/Ruby_logo.svg/360px-Ruby_logo.svg.png')
+```
+
+# TODO
+- Add tests to all clients methods
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/datagun.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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 "datagun"
+
+# 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/datagun.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative 'lib/datagun/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'datagun'
+  spec.version       = Datagun::VERSION
+  spec.authors       = ['Duccio Giovannelli']
+  spec.email         = ['giovannelli@extendi.it']
+
+  spec.summary       = spec.description
+  spec.description   = 'A Ruby interface to the Datagun API.'
+  spec.homepage      = 'https://github.com/4forges/datagun'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = 'https://github.com/4forges/datagun/blob/master/CHANGELOG.md'
+
+  # 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(__dir__)) 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_runtime_dependency 'rest-client', '~> 2.1.0'
+end

data/lib/datagun.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'logger'
+
+require 'datagun/version'
+require 'datagun/configuration'
+require 'datagun/concerns/http_wrapper'
+
+require 'datagun/api/base'
+require 'datagun/api/keywords_extractor/client'
+
+module Datagun
+  class Error < StandardError; end
+  class << self
+    attr_accessor :config
+
+    def configure
+      self.config = Datagun::Configuration.new
+      yield(config)
+    end
+  end
+end

data/lib/datagun/api/base.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Datagun
+  module Api
+    #
+    # Base class for Datagun
+    #
+    class Base
+      attr_reader :client, :logger
+
+      #
+      # Initialize Datagun::Base
+      #
+      # @param [Logger] default_logger
+      # i.e. nil || Logger.new
+      #
+      def initialize(default_logger: nil, version:)
+        @logger = default_logger || self.class.set_logger
+        @api_url = Datagun.config.api_url || 'https://api.datagun.ai'
+        @version = version
+      end
+
+      #
+      # Log to datagun.log file if Rails defined.
+      #
+      # @return [Logger]
+      #
+      def self.set_logger
+        @log_to ||= if defined?(::Rails)
+                      shift_age = 2
+                      shift_size = 50 * 1024 * 1024
+                      ::Logger.new("#{::Rails.root}/log/datagun.log", shift_age, shift_size)
+                    else
+                      ::Logger.new(STDOUT)
+                    end
+
+        # Debug level on IRB or if logger_level is present on Thread.current
+        @log_to.level = defined?(IRB) ? Logger::DEBUG : Thread.current[:logger_level] || Logger::INFO
+      end
+    end
+  end
+end

data/lib/datagun/api/community_detection/client.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Datagun
+  module Api
+    #
+    # Base class for Datagun
+    #
+    module CommunityDetection
+      #
+      # Client provide an HttpWrapper object that let
+      #
+      class Client < Datagun::Base
+        def initialize(default_logger: nil, version: Datagun.config.api_version)
+          super(default_logger: default_logger, version: version)
+          base_url = "#{@api_url}/api/#{@version}/community_detection"
+          @client = HttpWrapper.new(base_url: base_url)
+        end
+
+        def detect(graph:)
+          client.endpoint = 'lpa'
+          client.payload = {
+            graph: graph
+          }
+          client.post.map{transform_keys(&:to_sym)
+        end
+      end
+    end
+  end
+end

data/lib/datagun/api/image_hash/client.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Datagun
+  module Api
+    #
+    # Base class for Datagun
+    #
+    module ImageHash
+      #
+      # Client provide an HttpWrapper object that let
+      #
+      class Client < Datagun::Base
+        def initialize(default_logger: nil, version: Datagun.config.api_version)
+          super(default_logger: default_logger, version: version)
+          base_url = "#{@api_url}/api/#{@version}/image_hash"
+          @client = HttpWrapper.new(base_url: base_url)
+        end
+
+        def perceptual(url:)
+          client.endpoint = 'perceptual'
+          client.payload = {
+            url: url
+          }
+          client.get.transform_keys(&:to_sym)
+        end
+      end
+    end
+  end
+end

data/lib/datagun/api/keywords_extractor/client.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module Datagun
+  module Api
+    #
+    # Base class for Datagun
+    #
+    module KeywordsExtractor
+      #
+      # Client provides methods to interact with keywords_extractor endpoint
+      #
+      class Client < Base
+        def initialize(default_logger: nil, version: Datagun.config.api_version)
+          super(default_logger: default_logger, version: version)
+          base_url = "#{@api_url}/api/#{@version}/keyword_extractor"
+          @client = HttpWrapper.new(base_url: base_url)
+        end
+
+        #
+        # Store your corpus file
+        #
+        # @param [String] name: model name
+        # @param [Integer] features: max number of features to extract from the corpus
+        # @param [File] file
+        #
+        # @return [JSON]
+        #
+        def save_model(name:, features: nil, file:)
+          client.endpoint = 'save_model'
+          client.payload = {
+            model_name: name,
+            file: file
+          }
+          client.payload[:max_features] = features unless features.nil?
+          client.post.transform_keys(&:to_sym)
+        end
+
+        #
+        # Get status for a model_id
+        #
+        # @param [String] model_id
+        #
+        # @return [JSON]
+        #
+        def status(model_id:)
+          client.endpoint = 'status'
+          client.payload = {
+            model_id: model_id
+          }
+          client.get.transform_keys(&:to_sym)
+        end
+
+        #
+        # Return the list of keywords extractors models
+        #
+        # @return [JSON]
+        #
+        def models
+          client.endpoint = 'models'
+          client.get.map { |item| item.transform_keys(&:to_sym) }
+        end
+
+        #
+        # Delete a model
+        #
+        # @return [JSON]
+        #
+        def delete(model_id:)
+          client.endpoint = model_id
+          client.delete.transform_keys(&:to_sym)
+        end
+
+        #
+        # Extract top keywords from passed text using your model
+        #
+        # @param [String] model_id
+        # @param [String] text
+        #
+        # @return [JSON]
+        #
+        def analyze(model_id:, text:)
+          client.endpoint = 'analyze'
+          client.payload = {
+            model_id: model_id,
+            text: text
+          }
+          client.get.transform_keys(&:to_sym)
+        end
+      end
+    end
+  end
+end

data/lib/datagun/concerns/http_wrapper.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'rest-client'
+require 'json'
+#
+# Decorator class for the RestClient, mainly used to add the headers with authorization
+#
+class HttpWrapper
+  attr_accessor :payload
+  attr_writer :endpoint
+
+  def initialize(base_url:)
+    @base_url = base_url
+    @headers = {
+      'Authorization': Datagun.config.api_key
+    }
+  end
+
+  def post
+    JSON.parse(RestClient.post(url, payload, @headers).body)['data']
+  rescue StandardError => e
+    { error: e.message }
+  end
+
+  def get
+    JSON.parse(RestClient.get(url, { Authorization: Datagun.config.api_key, params: payload }).body)['data']
+  rescue StandardError => e
+    { error: e.message }
+  end
+
+  def delete
+    JSON.parse(RestClient.delete(url, { Authorization: Datagun.config.api_key }).body)['data']
+  rescue StandardError => e
+    { error: e.message }
+  end
+
+  def url
+    "#{@base_url}/#{@endpoint}"
+  end
+end

data/lib/datagun/configuration.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Datagun
+  class ConfigurationError < StandardError; end
+
+  #
+  # Datagun configuration
+  #
+
+  class Configuration
+    OPTIONAL_ATTRS = %i[api_url].freeze
+    MANDATORY_ATTRS = %i[api_key api_version].freeze
+
+    attr_accessor(*OPTIONAL_ATTRS)
+    attr_accessor(*MANDATORY_ATTRS)
+
+    MANDATORY_ATTRS.each do |attr|
+      define_method(attr) do
+        attr_value = instance_variable_get("@#{attr}")
+        if attr_value.nil? || attr_value.strip == ''
+          raise ConfigurationError, "Datagun #{attr} missing!"
+        end
+
+        attr_value
+      end
+    end
+  end
+end

data/lib/datagun/version.rb

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

data/lib/generators/datagun_generator.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+
+# Creates the Datagun initializer file for Rails apps.
+#
+# @example Invokation from terminal
+#   rails generate datagun
+#
+class DatagunGenerator < Rails::Generators::Base
+  desc "Description:\n  This creates a Rails initializer for Datagun"
+
+  source_root File.expand_path('templates', __dir__)
+
+  desc 'Configures Datagun to connect to Datagun api'
+  def generate_layout
+    template 'initializer.rb', 'config/initializers/datagun.rb'
+  end
+end

data/lib/generators/templates/initializer.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+Datagun.configure do |config|
+  config.api_key = 'your api key' # mandatory
+  config.api_version = 'v1' # mandatory
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: datagun
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Duccio Giovannelli
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-05-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+description: A Ruby interface to the Datagun API.
+email:
+- giovannelli@extendi.it
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- datagun.gemspec
+- lib/datagun.rb
+- lib/datagun/api/base.rb
+- lib/datagun/api/community_detection/client.rb
+- lib/datagun/api/image_hash/client.rb
+- lib/datagun/api/keywords_extractor/client.rb
+- lib/datagun/concerns/http_wrapper.rb
+- lib/datagun/configuration.rb
+- lib/datagun/version.rb
+- lib/generators/datagun_generator.rb
+- lib/generators/templates/initializer.rb
+homepage: https://github.com/4forges/datagun
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/4forges/datagun
+  source_code_uri: https://github.com/4forges/datagun
+  changelog_uri: https://github.com/4forges/datagun/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: ''
+test_files: []