loco-rb 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 206e7b0e2b517985ead122d426453905eff36f523dcb413ac096fb97384e8674
-  data.tar.gz: b45d912a7d2f8ce5cd604e03d34701e5a999bb21a1a9a25a33077540282aeb7e
+  metadata.gz: 2fc7ba233f13ce60d62bbc5b14b17974c5105b056693e3ecbf06fabcdafb2bce
+  data.tar.gz: 6c80afc1af56d4c825be427adf08f72da38ca8fd19c48e85992c634eb6494f81
 SHA512:
-  metadata.gz: b355529324747b5ad437e9e70dd35cb21d74c6f4ee4ddf2f157d8d1f409013737aa7d414e283ff402e4f758b68291cde1350b08797e9627be227a877bac4b98b
-  data.tar.gz: 253a49f4d26c4b5a0c2ec1bbb649845da14abf78fc8fcb616881b34e9f4c5c4a831087f4101c8d7b9b837b92a2347c13a390a2cee2d44806045b534347db4d68
+  metadata.gz: f48d608b516d9b1ee044e2b6101d967d75b1fdf50a38aeeedf6d2b2009a0c2eeaf43ecb3f2b785ff504b8a19d44fcc59eba6879c1b678089a3665c961f5f7c86
+  data.tar.gz: 5fa9447cdc99ece9f57db9c40419a784f8bc29bad468420aa520692074718dce9706a371101dec36960e45ce8ca7b80e7bd492a367d1b43d37f4fa3ab4cb7c45

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/Gemfile

@@ -4,4 +4,6 @@ source "https://rubygems.org"
 gemspec
 
 gem "rake", "~> 12.0"
-gem "minitest", "~> 5.0"
+gem 'faraday', '~> 1.10.0'
+gem 'rspec', '~> 3.5'
+gem 'webmock', '~> 3.14'

data/Gemfile.lock

@@ -0,0 +1,73 @@
+PATH
+  remote: .
+  specs:
+    loco-rb (0.1.0)
+      faraday (~> 1.10.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.5.0)
+    faraday (1.10.0)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0)
+      faraday-multipart (~> 1.0)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.0)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      faraday-retry (~> 1.0)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-multipart (1.0.3)
+      multipart-post (>= 1.2, < 3)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    faraday-retry (1.0.3)
+    hashdiff (1.0.1)
+    multipart-post (2.2.0)
+    public_suffix (4.0.7)
+    rake (12.3.3)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    ruby2_keywords (0.0.5)
+    webmock (3.14.0)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  universal-darwin-21
+
+DEPENDENCIES
+  faraday (~> 1.10.0)
+  loco-rb!
+  rake (~> 12.0)
+  rspec (~> 3.5)
+  webmock (~> 3.14)
+
+BUNDLED WITH
+   2.3.6

data/lib/loco-rb/api/asset.rb

@@ -0,0 +1,29 @@
+module LocoRb
+  module Api
+    module Asset
+      PATH = 'assets'
+      CREATE_PARAMS = %i[id text type context notes default].freeze
+
+      def get_assets(options={})
+        opts = {}
+        opts[:params] = { filter: options[:filter].join(',') } if options.dig( :filter)
+        response = get(PATH, opts)
+        response.data.map do |asset|
+          LocoRb::Resource::Asset.new(asset, response.headers, 'asset')
+        end
+      end
+
+      def create_asset(options={})
+        opts = {}
+        options.each do |key, value|
+          if CREATE_PARAMS.include?(key)
+            opts[:body] = {} unless opts.key?(:body)
+            opts[:body][key] = value
+          end
+        end
+        response = post(PATH, opts)
+        LocoRb::Resource::Asset.new(response.data, response.headers, 'asset')
+      end
+    end
+  end
+end

data/lib/loco-rb/api/export.rb

@@ -0,0 +1,12 @@
+module LocoRb
+  module Api
+    module Export
+      PATH = 'export'
+
+      def export_locale(options={locale: 'en', ext: 'json'})
+        response = get("#{PATH}/locale/#{options[:locale]}.#{options[:ext]}")
+        LocoRb::Resource::Locale.new(response.data, response.headers, 'locale').table
+      end
+    end
+  end
+end

data/lib/loco-rb/api/import.rb

@@ -0,0 +1,16 @@
+module LocoRb
+  module Api
+    module Import
+      PATH = 'import'
+
+      def import_locale(options={ext: 'json'})
+        opts = {}
+        opts[:params] = { locale: options[:locale] } if options.dig( :locale)
+        opts[:params] = opts[:params].merge({ "tag-updated": options[:tag_updated] }) if options.dig( :tag_updated)
+        opts[:body] = IO.read(options[:path])
+        response = post("#{PATH}/#{options[:ext] || 'json'}", opts)
+        LocoRb::Resource::Import.new(response.data, response.headers, 'import')
+      end
+    end
+  end
+end

data/lib/loco-rb/api/locale.rb

@@ -0,0 +1,25 @@
+module LocoRb
+  module Api
+    module Locale
+      PATH = 'locales'
+      CREATE_PARAMS = %i[code].freeze
+
+      def create_locale(options={})
+        opts = {}
+        options.each do |key, value|
+          if CREATE_PARAMS.include?(key)
+            opts[:body] = {} unless opts.key?(:body)
+            opts[:body][key] = value
+          end
+        end
+        response = post(PATH, opts)
+        LocoRb::Resource::Locale.new(response.data, response.headers, 'locale')
+      end
+
+      def get_locale(options={code: 'en'})
+        response = get("#{PATH}/#{options[:code]}")
+        LocoRb::Resource::Locale.new(response.data, response.headers, 'locale')
+      end
+    end
+  end
+end

data/lib/loco-rb/api.rb

@@ -0,0 +1,4 @@
+require 'loco-rb/api/asset'
+require 'loco-rb/api/locale'
+require 'loco-rb/api/export'
+require 'loco-rb/api/import'

data/lib/loco-rb/client.rb

@@ -0,0 +1,68 @@
+require 'faraday'
+require 'json'
+require 'ostruct'
+require 'loco-rb/resource'
+require 'loco-rb/api'
+
+module LocoRb
+  class Client
+    include LocoRb::Api::Asset
+    include LocoRb::Api::Locale
+    include LocoRb::Api::Export
+    include LocoRb::Api::Import
+
+    FILE_FORMAT = %w[application/pdf application/zip]
+
+    attr_accessor :options
+
+  private
+
+    def get(path, options={})
+      request_method(path, :get, options)
+    end
+
+    def post(path, options={})
+      request_method(path, :post, options)
+    end
+
+    def put(path, options={})
+      request_method(path, :put, options)
+    end
+
+    def delete(path, options={})
+      request_method(path, :delete, options)
+    end
+
+    def request_method(path, method_verb, options={})
+      response = request(path, method_verb, options)
+      validate(response)
+      parsed_response = parse(response)
+      OpenStruct.new({ headers: response.headers, data: parsed_response })
+    end
+
+    def request(path, method_verb, options={})
+      make_connection.send(method_verb) do |request|
+        request.url(path)
+        request.headers["Authorization"] = "Loco #{LocoRb.configuration.api_key}"
+        request.params = options[:params] if options[:params]
+        request.body = options[:body] if options[:body]
+      end
+    end
+
+    def make_connection
+      Faraday.new(url: LocoRb::Configuration::DEFAULT_ENDPOINT)
+    end
+
+    def validate(response)
+      raise LocoRb::Error.new(response.body) if response.status >= 400
+    end
+
+    def parse(response)
+      return response.body if FILE_FORMAT.include?(response['content-type'])
+      return {} if response.body.strip.empty?
+
+      JSON.parse(response.body.strip)
+    end
+  end
+end
+

data/lib/loco-rb/configuration.rb

@@ -0,0 +1,14 @@
+module LocoRb
+  class Configuration
+
+    DEFAULT_ENDPOINT = 'https://localise.biz/api'
+
+    attr_accessor :api_key, :locale_paths
+
+    def initialize
+      @api_key = nil
+      @locale_paths = []
+    end
+
+  end
+end

data/lib/loco-rb/resource/asset.rb

@@ -0,0 +1,11 @@
+require 'loco-rb/resource/base_resource'
+
+module LocoRb
+  module Resource
+    class Asset < LocoRb::Resource::BaseResource
+      def initialize(asset, headers, key='asset')
+        super(asset, headers, key)
+      end
+    end
+  end
+end

data/lib/loco-rb/resource/base_resource.rb

@@ -0,0 +1,12 @@
+module LocoRb
+  module Resource
+    class BaseResource < OpenStruct
+      attr_reader :key, :headers
+      def initialize(resource, headers, key=nil)
+        @key = key
+        @headers = headers
+        super(resource)
+      end
+    end
+  end
+end

data/lib/loco-rb/resource/export.rb

@@ -0,0 +1,11 @@
+require 'loco-rb/resource/base_resource'
+
+module LocoRb
+  module Resource
+    class Export < LocoRb::Resource::BaseResource
+      def initialize(asset, headers, key='export')
+        super(asset, headers, key)
+      end
+    end
+  end
+end

data/lib/loco-rb/resource/import.rb

@@ -0,0 +1,11 @@
+require 'loco-rb/resource/base_resource'
+
+module LocoRb
+  module Resource
+    class Import < LocoRb::Resource::BaseResource
+      def initialize(asset, headers, key='import')
+        super(asset, headers, key)
+      end
+    end
+  end
+end

data/lib/loco-rb/resource/locale.rb

@@ -0,0 +1,11 @@
+require 'loco-rb/resource/base_resource'
+
+module LocoRb
+  module Resource
+    class Locale < LocoRb::Resource::BaseResource
+      def initialize(asset, headers, key='locale')
+        super(asset, headers, key)
+      end
+    end
+  end
+end

data/lib/loco-rb/resource.rb

@@ -0,0 +1,4 @@
+require 'loco-rb/resource/asset'
+require 'loco-rb/resource/locale'
+require 'loco-rb/resource/import'
+require 'loco-rb/resource/export'

data/lib/loco-rb/version.rb

@@ -1,3 +1,3 @@
 module LocoRb
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/loco-rb.rb

@@ -1,6 +1,15 @@
 require "loco-rb/version"
+require "loco-rb/configuration"
+require "loco-rb/client"
 
 module LocoRb
   class Error < StandardError; end
-  # Your code goes here...
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
 end

data/loco-rb.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.description   = %q{Ruby client for Localize.biz Developer API}
   spec.homepage      = "https://github.com/mahesh-karipe/loco-rb"
   spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.0.0")
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/mahesh-karipe/loco-rb"
@@ -24,4 +24,5 @@ Gem::Specification.new do |spec|
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
+  spec.add_runtime_dependency "faraday", ['~> 1.10.0']
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: loco-rb
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Mahesh Karipe
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-25 00:00:00.000000000 Z
-dependencies: []
+date: 2022-07-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.10.0
 description: Ruby client for Localize.biz Developer API
 email:
 - mahesh.karipe@ooma.com
@@ -18,16 +32,31 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
 - lib/loco-rb.rb
+- lib/loco-rb/api.rb
+- lib/loco-rb/api/asset.rb
+- lib/loco-rb/api/export.rb
+- lib/loco-rb/api/import.rb
+- lib/loco-rb/api/locale.rb
+- lib/loco-rb/client.rb
+- lib/loco-rb/configuration.rb
+- lib/loco-rb/resource.rb
+- lib/loco-rb/resource/asset.rb
+- lib/loco-rb/resource/base_resource.rb
+- lib/loco-rb/resource/export.rb
+- lib/loco-rb/resource/import.rb
+- lib/loco-rb/resource/locale.rb
 - lib/loco-rb/version.rb
 - loco-rb.gemspec
 homepage: https://github.com/mahesh-karipe/loco-rb
@@ -45,14 +74,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.9
 signing_key:
 specification_version: 4
 summary: Ruby client for Localize.biz Developer API