phraseapp-rest 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c5a5a272b0670ebe10aae74e43fad430ff6e24b37528b9de21f81e48abac480d
+  data.tar.gz: 52f2fe992459573931d2f2ae0df72fe385c9ac5b52e457fa8dfead7b124ef600
+SHA512:
+  metadata.gz: dfbe176509ba75e52c82d7e0599e9d1939788e24c5f655b50c0624888662d1f0ed3fc56a2ca7051748dbab39bf9117ceed7861c361b0467c87a92383ce442843
+  data.tar.gz: a781f2e78575d6001db433de3d2388d2f8d7e9f3c8fbbbfb7a48ae232eeb09450cb0f5452c97165f65320b620a11be367519ea8bcb0c5cc75b96ec4520be5379

data/lib/phraseapp-rest/api.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Phraseapp
+  module Rest
+    class Api
+      BASE_URL = 'https://api.phraseapp.com/api/v2'
+      def initialize(rest_client: client, token: access_token)
+        @client = rest_client
+        @token = token
+      end
+
+      def get(path)
+        response @client::Request.execute(
+          url: "#{BASE_URL}#{path}",
+          method: :get,
+          user: @token,
+          content_type: :json,
+          accept: :json,
+          verify_ssl: TRUE
+        )
+      end
+
+      private
+
+      def response(call)
+        rsp, err = call
+        raise err.inspect if err
+
+        rsp
+      end
+    end
+  end
+end

data/lib/phraseapp-rest/factory.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'rest-client'
+require_relative 'api'
+
+module Phraseapp
+  module Rest
+    class Factory
+      def self.api
+        Phraseapp::Rest::Api.new(rest_client: RestClient, token: ENV['PHRASEAPP_API_KEY'])
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Phraseapp
+  module Rest
+    module Parameter
+      class Base
+        attr_accessor :branch, :sort
+        attr_reader :order
+
+        def initialize(branch: nil, sort: nil, order: nil)
+          @branch = branch unless branch.nil?
+          @sort = sort unless sort.nil?
+          self.order = order unless order.nil?
+        end
+
+        def order=(str)
+          message = "'#{str}' is not supported. Please use 'asc' or 'desc'"
+          raise message unless %w(asc desc).include?(str)
+
+          @order = str
+        end
+
+        def to_s
+          hash = {}
+          %w(branch sort order).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
+      end
+    end
+  end
+end

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

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require 'uri'
+require 'time'
+
+module Phraseapp
+  module Rest
+    module Query
+      class Base
+        attr_accessor :id, :tags
+        attr_reader :unverified, :excluded, :updated_at
+
+        def initialize(id: nil, tags: nil, unverified: nil, excluded: nil, updated_at: nil)
+          @id = id
+          @tags = tags
+          self.unverified = unverified unless unverified.nil?
+          self.excluded = excluded unless excluded.nil?
+          self.updated_at = updated_at unless updated_at.nil?
+        end
+
+        def unverified=(bool)
+          @unverified = set bool
+        end
+
+        def excluded=(bool)
+          @excluded = set bool
+        end
+
+        def updated_at=(date_range)
+          # validates that date format is ISO8601
+          regex = /[<=>]+[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(Z|((\+|\-)[0-9]{2}:[0-9]{2}))+/
+          error_message = ArgumentError.new 'updated_at must be of format {>=|<=}2013-02-21T00:00:00Z'
+          raise error_message if date_range.nil? || date_range.match(regex).nil?
+
+          @updated_at = date_range
+        end
+
+        def to_s
+          hash = {}
+          %w(id tags unverified excluded updated_at).each do |attr|
+            hash[attr.to_sym] = URI.encode_www_form_component(send(attr)) unless send(attr).nil?
+          end
+          'q=' + hash.to_a.map { |x| "#{x[0]}:#{x[1]}" }.join('%20').to_s unless hash.empty?
+        end
+
+        private
+
+        def set(bool)
+          message = "#{caller(1..1).first} error '#{bool}' is not supported. Please use TRUE or FALSE"
+          raise message unless [true, false].include? bool
+
+          bool.to_s
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative 'parser'
+require_relative 'list'
+
+module Phraseapp
+  module Rest
+    module Resource
+      class Key
+        include Parser
+        include List
+
+        def initialize(client:, project_id:)
+          @client = client
+          @path = "/projects/#{project_id}/keys"
+        end
+
+        def get(id:)
+          parse(@client.get("#{@path}/#{id}"))
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'time'
+
+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?
+          items
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative 'parser'
+require_relative 'list'
+
+module Phraseapp
+  module Rest
+    module Resource
+      class Locale
+        include Parser
+        include List
+
+        def initialize(client:, project_id:)
+          @client = client
+          @path = "/projects/#{project_id}/locales"
+        end
+
+        def get(id:)
+          parse(@client.get("#{@path}/#{id}"))
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module Phraseapp
+  module Rest
+    module Resource
+      module Parser
+        OPTIONS = { max_nesting: 4, symbolize_names: TRUE, object_class: OpenStruct }.freeze
+
+        def parse(json)
+          JSON.parse(json, OPTIONS)
+        end
+      end
+    end
+  end
+end

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

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

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

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

data/lib/phraseapp-rest/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Phraseapp
+  module Rest
+    VERSION = '0.1.0'
+  end
+end

data/lib/phraseapp-rest.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative 'phraseapp-rest/version'
+require_relative 'phraseapp-rest/factory'
+require_relative 'phraseapp-rest/parameter/base'
+require_relative 'phraseapp-rest/query/base'
+require_relative 'phraseapp-rest/resource/key'
+require_relative 'phraseapp-rest/resource/locale'
+require_relative 'phraseapp-rest/resource/project'
+require_relative 'phraseapp-rest/resource/translation'

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: phraseapp-rest
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sebastian Nepote
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-11-11 00:00:00.000000000 Z
+dependencies: []
+description: A ruby gem to interact with Phraseapp REST resources
+email: snepote@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/phraseapp-rest.rb
+- lib/phraseapp-rest/api.rb
+- lib/phraseapp-rest/factory.rb
+- lib/phraseapp-rest/parameter/base.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/parser.rb
+- lib/phraseapp-rest/resource/project.rb
+- lib/phraseapp-rest/resource/translation.rb
+- lib/phraseapp-rest/version.rb
+homepage: http://rubygems.org/gems/phraseapp-rest
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: Phraseapp rest api resource collection
+test_files: []