easy_manage_client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 516e8348314da4e3265d1d59ec548ea634a756aa3e5d957dcf5c7e067e206522
+  data.tar.gz: e5b3eb4b2559746393c38d4847de3d57bec07cde5278966e571d44d0c38116ba
+SHA512:
+  metadata.gz: ce4eea5e6b968b44c528fe12096bd64ddca6238c347576768ce177679efe596bb5e5f7989dfad10cfc6ca12726cad1a5f35c7414246b463500825a75dbfc8533
+  data.tar.gz: 5ec2aad214355b7e032760edf9533d5f3d10116a6a0dbc06098d09b36d35f9f02be31b0eb87a0a32db23d40eb29a13fda00ad910ca61a7cf9d6c989217cce49d

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/*[.yml, .json]
+Gemfile.lock
+.env
+.byebug_history
+*.gem

data/.rubocop.yml

@@ -0,0 +1,10 @@
+# The behavior of RuboCop can be controlled via the .rubocop.yml
+# configuration file. It makes it possible to enable/disable
+# certain cops (checks) and to alter their behavior if they accept
+# any parameters. The file can be placed either in your home
+# directory or in some project directory.
+#
+# RuboCop will start looking for the configuration file in the directory
+# where the inspected file is and continue its way up to the root directory.
+#
+# See https://github.com/rubocop-hq/rubocop/blob/master/manual/configuration.md

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+before_install: gem install bundler -v 2.1.2
+rvm:
+  - 2.3
+  - 2.4
+  - 2.5
+  - 2.6
+  - 2.7
+install:
+  - bundle install --retry=3
+script:
+  - bundle exec rake test
+  - bundle exec rake rubocop

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,108 @@
+# EasyManageClient [![Build Status](https://travis-ci.org/sertangulveren/easy_manage_client.svg?branch=master)](https://travis-ci.org/sertangulveren/easy_manage_client)
+
+This client allows you to download compiled dumps in JSON or YAML format, such as translation, configuration etc. on EasyManage server to your project easly.
+
+It is recommended to use at the projects initial stage.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'easy_manage_client'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install easy_manage_client
+
+## Configuration
+
+Client must be configured before use. Configuration fields are as:
+
+| Field           | Description                                                                                             |
+| --------------- | ------------------------------------------------------------------------------------------------------- |
+| root_url        | Root url of the EasyManage server.                                                                      |
+| auth_token      | Your 2.0 authentication token string without the 'Bearer'.                                              |
+| extension       | Dump format. Available values: 'json', 'yml'                                                            |
+| download_folder | Information to which folder the dump will be downloaded.                                                |
+| compile_id      | The id of the compiled version. If not passed, the client always downloads the latest compiled dump.    |
+
+### Configuration on Rails Application:
+Create a file in the `config/initializers` directory and configure client in this file as below:
+`# config/initializers/easy_manage_client.rb`
+```ruby
+EasyManageClient.configure do |config|
+  config.root_url = 'https://easymanage.example.com'
+  config.auth_token = 'YOUR_SECRET_AUTH_TOKEN'
+  config.extension = 'yml'
+  config.download_folder = File.join(Rails.root, 'config', 'translations')
+  config.compile_id = 'SPECIAL_COMPILED_VERSION_ID'
+end
+```
+### Multiple Configuration
+You can define multiple configurations separated by profile. To do this, you must pass the profile parameter to the `configure` definition.
+If the profile name is not pass in the configuration, it defaults to use `:default`.
+##### Example:
+In this example, to download dynamicly application settings, profile name specified as `settings`.
+`# config/initializers/dynamic_settings.rb`
+```ruby
+EasyManageClient.configure(:dynamic_settings) do |config|
+  config.root_url = 'https://easymanage.example.com'
+  config.auth_token = 'YOUR_SECRET_AUTH_TOKEN'
+  config.extension = 'json'
+  config.download_folder = File.join(Rails.root, 'config', 'settings')
+end
+```
+## Usage
+Initialize a client object before starting process.
+```ruby
+client = EasyManageClient::Downloader.new
+```
+To download compiled dump, call the method `perform`.
+The client downloads the compiled version to the directory specified in the configuration, in the specified format.
+In this case, client uses the folder: `File.join(Rails.root, 'config', 'translations')`.
+```ruby
+client.perform
+```
+
+> In case of an unsuccessful download; `perform!` can be used instead of `perform` for error exception. This method creates an `EasyManageClient::DownloadProcessFailed` exception.
+
+You can pass the profile argument on client initialization to use different configuration.
+```ruby
+client = EasyManageClient::Downloader.new(profile: :dynamic_settings)
+client.perform
+```
+
+If the download process will be performed only in the Rails initialization, the following method can be used:
+`# config/initializers/easy_manage_client.rb`
+```ruby
+EasyManageClient.configure(:dummy_profile) do |config|
+  config.root_url = 'https://easymanage.example.com'
+  config.auth_token = 'YOUR_SECRET_AUTH_TOKEN'
+  config.extension = 'yml'
+  config.download_folder = File.join(Rails.root, 'config', 'settings')
+end
+client = EasyManageClient::Downloader.new(profile: :dummy_profile)
+client.perform!
+```
+
+### Using Rake Tasks
+The client has its own rake tasks.
+This feature can be used in configurations such as CI configurations, Dockerfile etc.
+
+Use rake task to download your compiled dump as below:
+
+`rake easy_manage_client:download`
+
+Pass profile to rake task:
+
+`easy_manage_client:download PROFILE=dummy_settings`
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sertangulveren/easy_manage_client.
+

data/Rakefile

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rubocop/rake_task'
+
+import('lib/tasks/easy_manage_client.rake')
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+  t.warning = false
+end
+
+task default: :test
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'easy_manage_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/easy_manage_client.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative 'lib/easy_manage_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'easy_manage_client'
+  spec.version       = EasyManageClient::VERSION
+  spec.authors       = ['Sertan Gülveren', 'Yiğit Sadıç']
+  spec.email         = ['sertangulveren@gmail.com', 'yigitsadic@gmail.com']
+
+  spec.summary       = 'EasyManage API client for ruby.'
+  spec.description   = 'It is a simple ruby client for EasyManage API.'
+  spec.homepage      = 'https://github.com/sertangulveren/easy_manage_client'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+
+  # 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 do |f|
+      f.match(%r{^(test|spec|features)/})
+    end
+  end
+
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency('dotenv', '~> 2.7')
+  spec.add_development_dependency('minitest', '~> 5.0')
+  spec.add_development_dependency('rake', '~> 12.0')
+  spec.add_development_dependency('rubocop', '~> 0.79.0')
+  spec.add_development_dependency('simplecov', '~> 0.17.1')
+  spec.add_development_dependency('webmock', '~> 3.8')
+
+  spec.add_dependency('faraday', '~> 0.11.0')
+end

data/lib/easy_manage_client/configuration.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+# main module
+module EasyManageClient
+  class << self
+    attr_accessor :configurations
+
+    def configuration(profile = :default)
+      raise NoProfilesWereFound if configurations.nil? || configurations.empty?
+
+      configurations.select do |conf|
+        conf.profile == profile
+      end.first || raise(ProfileNotFound, "Undefined profile: #{profile}")
+    end
+
+    private
+
+    def reject_profile(profile)
+      configurations.reject! { |conf| conf.profile == profile }
+    end
+
+    def initialize_configuration
+      self.configurations = [] if configurations.nil?
+      Configuration.new
+    end
+
+    def after_configuration_events(conf, profile)
+      conf.profile = profile # FORCE!
+      conf.check!
+      reject_profile(profile)
+      configurations << conf
+    end
+  end
+
+  def self.configure(profile = :default)
+    conf = initialize_configuration
+    yield(conf)
+    after_configuration_events(conf, profile)
+  end
+
+  # Configuration class
+  class Configuration
+    EXTENSION_TYPES = %w[yml json].freeze
+
+    attr_accessor :profile, :root_url, :auth_token, :extension, :compile_id,
+                  :download_folder
+
+    def initialize
+      self.profile = :default
+      self.extension = 'yml'
+    end
+
+    def check!
+      raise InvalidExtension unless EXTENSION_TYPES.include?(extension)
+    end
+  end
+end

data/lib/easy_manage_client/core.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module EasyManageClient
+  # Core
+  class Core
+    attr_accessor :connection, :profile, :response, :success
+    def initialize(profile: :default)
+      self.profile = profile
+      # Firstly, create a connection object.
+      self.connection = Faraday.new(
+        url: ::EasyManageClient.configuration(profile).root_url,
+        headers: headers, params: params
+      )
+    end
+
+    # Call the api and process the response.
+    def perform
+      resp = connection.get(request_uri)
+      handle_response(resp)
+      # If server returns 200, everything is OK.
+      self.success = resp.status == 200
+    rescue Faraday::Error => e
+      self.response = { message: e.message }
+      self.success = false
+    rescue JSON::ParserError, ::EasyManageClient::InvalidResponseContent
+      # Response cannot be handled.
+      self.response = { message: 'Invalid response from the server.' }
+      self.success = false
+    end
+
+    # Response is parsed and checked here.
+    def handle_response(resp)
+      self.response = JSON.parse(resp.body, symbolize_names: true)
+
+      # :content and :reference must be included in response.
+      if response.keys.include?(:content) && response.keys.include?(:reference)
+        return
+      end
+
+      # :content or :reference not included.
+      raise ::EasyManageClient::InvalidResponseContent
+    end
+
+    # Headers prepared here.
+    def headers
+      { 'Authorization' => generate_bearer_token }
+    end
+
+    # Generate Bearer token from configuration.
+    def generate_bearer_token
+      "Bearer #{::EasyManageClient.configuration(profile).auth_token}"
+    end
+
+    # Parameters are prepared here.
+    def params
+      { version: ::EasyManageClient.configuration(profile).extension }
+    end
+  end
+end

data/lib/easy_manage_client/downloader.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module EasyManageClient
+  # Downloader
+  class Downloader < Core
+    def request_uri
+      # if version not specified, use latest uri
+      if ::EasyManageClient.configuration(profile).compile_id.nil?
+        return latest_version_uri
+      end
+
+      # generate compiled_version_uri
+      compiled_version_uri
+    end
+
+    def perform
+      # make api call and handle response
+      super
+      # if success is not true
+      # stop operation and return false
+      return false unless success
+
+      # download data to the relevant location
+      write_to_folder
+      true
+    end
+
+    def perform!
+      perform
+      unless success
+        raise ::EasyManageClient::DownloadProcessFailed, response[:message]
+      end
+
+      true
+    end
+
+    def compiled_version_uri
+      '/api/projects/by_reference/' +
+        ::EasyManageClient.configuration(profile).compile_id.to_s
+    end
+
+    def latest_version_uri
+      '/api/projects/latest_compiled_version'
+    end
+
+    def write_to_folder
+      File.open(prepare_file_path_to_download, 'w') do |file|
+        file.write(response[:content])
+      end
+    end
+
+    def prepare_file_path_to_download
+      folder = ::EasyManageClient.configuration(profile).download_folder
+      extension = ::EasyManageClient.configuration(profile).extension
+      File.join(folder, "#{response[:reference]}.#{extension}")
+    end
+  end
+end

data/lib/easy_manage_client/railtie.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'easy_manage_client'
+require 'rails'
+
+module EasyManageClient
+  # Railtie
+  class Railtie < Rails::Railtie
+    railtie_name :easy_manage_client
+
+    rake_tasks do
+      load 'tasks/easy_manage_client.rake'
+    end
+  end
+end

data/lib/easy_manage_client/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module EasyManageClient
+  VERSION = '0.1.0'
+end

data/lib/easy_manage_client.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require 'easy_manage_client/version'
+require 'easy_manage_client/configuration'
+require 'easy_manage_client/core'
+require 'easy_manage_client/downloader'
+require 'easy_manage_client/railtie' if defined?(Rails)
+
+module EasyManageClient
+  class Error < StandardError; end
+  class InvalidResponseContent < Error; end
+  class ProfileNotFound < Error; end
+  class InvalidExtension < Error; end
+  class NoProfilesWereFound < Error; end
+  class DownloadProcessFailed < Error; end
+end

data/lib/tasks/easy_manage_client.rake

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'easy_manage_client'
+namespace :easy_manage_client do
+  desc 'Download the dump.'
+  task :download do
+    profile = ENV.fetch('PROFILE', :default).to_sym
+    puts "EasyManageClient running for: #{profile}"
+    downloader = ::EasyManageClient::Downloader.new(profile: profile)
+    puts "EasyManageClient processing for: #{profile}"
+    downloader.perform!
+    puts "EasyManageClient process successfully completed for: #{profile}"
+  end
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: easy_manage_client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sertan Gülveren
+- Yiğit Sadıç
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-01-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.79.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.79.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.1
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+description: It is a simple ruby client for EasyManage API.
+email:
+- sertangulveren@gmail.com
+- yigitsadic@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- easy_manage_client.gemspec
+- lib/easy_manage_client.rb
+- lib/easy_manage_client/configuration.rb
+- lib/easy_manage_client/core.rb
+- lib/easy_manage_client/downloader.rb
+- lib/easy_manage_client/railtie.rb
+- lib/easy_manage_client/version.rb
+- lib/tasks/easy_manage_client.rake
+- tmp/.keep
+homepage: https://github.com/sertangulveren/easy_manage_client
+licenses: []
+metadata:
+  homepage_uri: https://github.com/sertangulveren/easy_manage_client
+  source_code_uri: https://github.com/sertangulveren/easy_manage_client
+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: EasyManage API client for ruby.
+test_files: []