easy_manage_client 0.1.0 → 0.1.1

checksums.yaml

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

data/README.md

@@ -28,7 +28,7 @@ Client must be configured before use. Configuration fields are as:
 | --------------- | ------------------------------------------------------------------------------------------------------- |
 | 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'                                                            |
+| extension       | Dump format. Available values: 'json', 'yaml'                                                            |
 | 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.    |
 
@@ -39,7 +39,7 @@ Create a file in the `config/initializers` directory and configure client in thi
 EasyManageClient.configure do |config|
   config.root_url = 'https://easymanage.example.com'
   config.auth_token = 'YOUR_SECRET_AUTH_TOKEN'
-  config.extension = 'yml'
+  config.extension = 'yaml'
   config.download_folder = File.join(Rails.root, 'config', 'translations')
   config.compile_id = 'SPECIAL_COMPILED_VERSION_ID'
 end
@@ -84,7 +84,7 @@ If the download process will be performed only in the Rails initialization, the
 EasyManageClient.configure(:dummy_profile) do |config|
   config.root_url = 'https://easymanage.example.com'
   config.auth_token = 'YOUR_SECRET_AUTH_TOKEN'
-  config.extension = 'yml'
+  config.extension = 'yaml'
   config.download_folder = File.join(Rails.root, 'config', 'settings')
 end
 client = EasyManageClient::Downloader.new(profile: :dummy_profile)
@@ -99,9 +99,9 @@ Use rake task to download your compiled dump as below:
 
 `rake easy_manage_client:download`
 
-Pass profile to rake task:
+Pass profile to rake task via environment variable:
 
-`easy_manage_client:download PROFILE=dummy_settings`
+`rake easy_manage_client:download EASY_MANAGE_PROFILE=dummy_settings`
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/sertangulveren/easy_manage_client.

data/lib/easy_manage_client/configuration.rb

@@ -40,14 +40,19 @@ module EasyManageClient
 
   # Configuration class
   class Configuration
-    EXTENSION_TYPES = %w[yml json].freeze
+    EXTENSION_TYPES = %w[yaml json].freeze
+    FILE_EXTENSION_TYPES = { 'yaml' => 'yml', 'json' => 'json' }.freeze
 
     attr_accessor :profile, :root_url, :auth_token, :extension, :compile_id,
                   :download_folder
 
     def initialize
       self.profile = :default
-      self.extension = 'yml'
+      self.extension = 'yaml'
+    end
+
+    def file_extension
+      FILE_EXTENSION_TYPES[extension]
     end
 
     def check!

data/lib/easy_manage_client/downloader.rb

@@ -3,6 +3,7 @@
 module EasyManageClient
   # Downloader
   class Downloader < Core
+    # It decides which api endpoint to use and returns this endpoit.
     def request_uri
       # if version not specified, use latest uri
       if ::EasyManageClient.configuration(profile).compile_id.nil?
@@ -13,46 +14,54 @@ module EasyManageClient
       compiled_version_uri
     end
 
+    # Call api, handle response, perform all actions according to success.
+    # Method returns true or false.
     def perform
       # make api call and handle response
       super
-      # if success is not true
-      # stop operation and return false
+
+      # If success is not true, stop operation and return false.
       return false unless success
 
-      # download data to the relevant location
+      # Download data to the relevant location.
       write_to_folder
       true
     end
 
+    # CRASH! If unsuccessful.
     def perform!
       perform
       unless success
         raise ::EasyManageClient::DownloadProcessFailed, response[:message]
       end
 
+      # Everything is OK.
       true
     end
 
+    # Returns request uri from specified version.
     def compiled_version_uri
       '/api/projects/by_reference/' +
         ::EasyManageClient.configuration(profile).compile_id.to_s
     end
 
+    # Returns request uri for latest version.
     def latest_version_uri
       '/api/projects/latest_compiled_version'
     end
 
+    # Write content to download folder.
     def write_to_folder
       File.open(prepare_file_path_to_download, 'w') do |file|
         file.write(response[:content])
       end
     end
 
+    # Prepares a file path from the specified extension and download folder.
     def prepare_file_path_to_download
       folder = ::EasyManageClient.configuration(profile).download_folder
-      extension = ::EasyManageClient.configuration(profile).extension
-      File.join(folder, "#{response[:reference]}.#{extension}")
+      file_extension = ::EasyManageClient.configuration(profile).file_extension
+      File.join(folder, "#{response[:reference]}.#{file_extension}")
     end
   end
 end

data/lib/easy_manage_client/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: easy_manage_client
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Sertan Gülveren
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-28 00:00:00.000000000 Z
+date: 2020-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv