phraseapp-rest 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aeb5a1f70cc0b3bbc18e09db604d9d4d371dc1c2cd3be5c3654a6bcb1ec95df3
-  data.tar.gz: 8d59180055808da44bda6677f6250391660efa02afc710fea82a27329212219a
+  metadata.gz: dcf5df54e3d660ea4a82d27e471fe32c871833e8d9b88b9ad17991eea0b0112a
+  data.tar.gz: cecae224b2fb9f3606b46a0fa368e1e2d9e25b41dc97ebc80aa693516bc999b9
 SHA512:
-  metadata.gz: 8db678e36e6c2be20a1a852a5a67b967636af6f84737ee698793f691f395f2c69693fe891a35fd193a503f0c2b95ff678a891713b5880d362a000dfa50741f15
-  data.tar.gz: 31079849e5161246bd714439d9e0d11b26cdd2bd12ab8450f5093c433e5cb50b615530d74a84d97d0874535c60403ef7debe6e83a74cbb0bc4cd49a40ad647a5
+  metadata.gz: e83f4398a972cc04f5dd89c756ce79df724d3fa5693df7da900432ea95dbd7bd453f9d9acbde328565625fb4edeaf53a9ff03f39bf62f93513f045e523f1c2f7
+  data.tar.gz: 8c0590aeaa06d5d2cdac8dfc110bb9815355cd6e05ec0d79cd33d1908abd08cee01d045cbd3ae9c8c054e34d6c44e3811d0029a4df5c6402e40bf6486310f8f4

data/lib/phraseapp-rest/api.rb

@@ -4,22 +4,21 @@ module Phraseapp
   module Rest
     class Api
       BASE_URL = 'https://api.phraseapp.com/api/v2'
-      def initialize(rest_client: client, token: access_token)
+      def initialize(rest_client:, token:)
         @client = rest_client
         @token = token
       end
 
       def get(path)
-        rsp, err = @client::Request.execute(
+        rsp, _err = @client::Request.execute(
           url: "#{BASE_URL}#{path}",
           method: :get,
           user: @token,
-          content_type: :json, accept: :json,
-          verify_ssl: TRUE
+          content_type: :json, accept: :json, verify_ssl: TRUE
         )
-        rsp
-      rescue RestClient::ExceptionWithResponse => e
-        return '[]' if e.response = 404
+        rsp.body
+      rescue @client::ExceptionWithResponse => e
+        return '[]' if e.response.code == 404
 
         raise e
       end

data/lib/phraseapp-rest/parameter/base.rb

@@ -22,11 +22,17 @@ module Phraseapp
 
         def to_s
           hash = {}
-          %w(branch sort order).each do |attr|
+          params.each do |attr|
             hash[attr.to_sym] = send(attr) unless send(attr).nil?
           end
           hash.to_a.map { |x| "#{x[0]}=#{x[1]}" }.join('&').to_s
         end
+
+        protected
+
+        def params
+          %w(branch sort order)
+        end
       end
     end
   end

data/lib/phraseapp-rest/parameter/download.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Phraseapp
+  module Rest
+    module Parameter
+      class Download < Base
+        FILE_FORMAT = ['simple_json'].freeze
+
+        attr_reader :file_format
+
+        def initialize(file_format: 'simple_json')
+          self.file_format = file_format
+        end
+
+        def file_format=(format)
+          raise "file format #{format} not supported" unless FILE_FORMAT.include?(format)
+
+          @file_format = format
+        end
+
+        protected
+
+        def params
+          %w(file_format)
+        end
+      end
+    end
+  end
+end

data/lib/phraseapp-rest/resource/key.rb

@@ -1,13 +1,12 @@
 # frozen_string_literal: true
 
-require_relative 'parser'
 require_relative 'list'
+require_relative 'parser'
 
 module Phraseapp
   module Rest
     module Resource
       class Key
-        include Parser
         include List
 
         def initialize(client:, project_id:)
@@ -16,7 +15,7 @@ module Phraseapp
         end
 
         def get(id:)
-          parse(@client.get("#{@path}/#{id}"))
+          Parser.parse(@client.get("#{@path}/#{id}"))
         end
       end
     end

data/lib/phraseapp-rest/resource/list.rb

@@ -1,16 +1,25 @@
 # frozen_string_literal: true
 
 require 'time'
+require_relative 'page'
+require_relative 'parser'
 
 module Phraseapp
   module Rest
     module Resource
       module List
-        def list(updated_after: nil)
-          items = parse(@client.get(@path))
-          items.delete_if { |i| Time.parse(i.updated_at) < updated_after } unless updated_after.nil?
+        def list(updated_after: nil, page: nil)
+          path = @path + ("&#{page}" unless page.nil?).to_s
+          items = Parser.parse(@client.get(path))
+          items = remove(items, updated_after) unless updated_after.nil?
           items
         end
+
+        private
+
+        def remove(items, updated_after)
+          items.delete_if { |i| Time.parse(i[:updated_at]) < updated_after }
+        end
       end
     end
   end

data/lib/phraseapp-rest/resource/locale.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-require_relative 'parser'
 require_relative 'list'
+require_relative 'parser'
+require_relative '../parameter/download'
 
 module Phraseapp
   module Rest
     module Resource
       class Locale
-        include Parser
         include List
 
         def initialize(client:, project_id:)
@@ -16,7 +16,13 @@ module Phraseapp
         end
 
         def get(id:)
-          parse(@client.get("#{@path}/#{id}"))
+          Parser.parse(@client.get("#{@path}/#{id}"))
+        end
+
+        def download(id:, params: Phraseapp::Rest::Parameter::Download.new)
+          path = "#{@path}/#{id}/download"
+          path += "?#{params}" unless params.nil?
+          @client.get(path)
         end
       end
     end

data/lib/phraseapp-rest/resource/page.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Phraseapp
+  module Rest
+    module Resource
+      class Page
+        def initialize(number: 1, size: 25)
+          @number = number
+          @size = size
+        end
+
+        def to_s
+          "page=#{@number}&per_page=#{@size}"
+        end
+      end
+    end
+  end
+end

data/lib/phraseapp-rest/resource/parser.rb

@@ -6,9 +6,9 @@ module Phraseapp
   module Rest
     module Resource
       module Parser
-        OPTIONS = { max_nesting: 4, symbolize_names: TRUE, object_class: OpenStruct }.freeze
+        OPTIONS = { max_nesting: 4, symbolize_names: TRUE }.freeze
 
-        def parse(json)
+        def self.parse(json)
           JSON.parse(json, OPTIONS)
         end
       end

data/lib/phraseapp-rest/resource/project.rb

@@ -1,13 +1,12 @@
 # frozen_string_literal: true
 
-require_relative 'parser'
 require_relative 'list'
+require_relative 'parser'
 
 module Phraseapp
   module Rest
     module Resource
       class Project
-        include Parser
         include List
 
         def initialize(client:)
@@ -16,7 +15,7 @@ module Phraseapp
         end
 
         def get(id:)
-          parse(@client.get("#{@path}/#{id}"))
+          Parser.parse(@client.get("#{@path}/#{id}"))
         end
       end
     end

data/lib/phraseapp-rest/resource/translation.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
+require_relative 'page'
 require_relative 'parser'
 
 module Phraseapp
   module Rest
     module Resource
       class Translation
-        include Parser
         require_relative 'list'
 
         def initialize(client:, project_id:)
@@ -15,23 +15,25 @@ module Phraseapp
         end
 
         def get(id:)
-          parse(@client.get("#{@path}/translations/#{id}"))
+          Parser.parse(@client.get("#{@path}/translations/#{id}"))
         end
 
-        def list
-          parse(@client.get("#{@path}/translations"))
+        def list(page: Resource::Page.new)
+          path = "#{@path}/translations"
+          path += querystring(page: page)
+          Parser.parse(@client.get(path))
         end
 
-        def list_by_locale(locale_id: id, param: nil, query: nil)
+        def list_by_locale(locale_id:, param: nil, query: nil, page: Resource::Page.new)
           path = "#{@path}/locales/#{locale_id}/translations"
-          path += querystring(param: param, query: query)
-          parse(@client.get(path))
+          path += querystring(param: param, query: query, page: page)
+          Parser.parse(@client.get(path))
         end
 
         private
 
-        def querystring(param: nil, query: nil)
-          str = [param.to_s, query.to_s].join('&')
+        def querystring(param: nil, query: nil, page:)
+          str = [param, query, page].compact.map(&:to_s).join('&')
           "?#{str}" unless str.empty?
         end
       end

data/lib/phraseapp-rest/version.rb

@@ -2,6 +2,6 @@
 
 module Phraseapp
   module Rest
-    VERSION = '0.2.0'
+    VERSION = '0.3.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: phraseapp-rest
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Sebastian Nepote
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-20 00:00:00.000000000 Z
+date: 2018-12-02 00:00:00.000000000 Z
 dependencies: []
 description: A ruby gem to interact with Phraseapp REST resources
 email: snepote@gmail.com
@@ -21,10 +21,12 @@ files:
 - lib/phraseapp-rest/configuration.rb
 - lib/phraseapp-rest/factory.rb
 - lib/phraseapp-rest/parameter/base.rb
+- lib/phraseapp-rest/parameter/download.rb
 - lib/phraseapp-rest/query/base.rb
 - lib/phraseapp-rest/resource/key.rb
 - lib/phraseapp-rest/resource/list.rb
 - lib/phraseapp-rest/resource/locale.rb
+- lib/phraseapp-rest/resource/page.rb
 - lib/phraseapp-rest/resource/parser.rb
 - lib/phraseapp-rest/resource/project.rb
 - lib/phraseapp-rest/resource/translation.rb