phraseapp-ruby 1.1.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 950c9514932e26d986a5b5cde46e555678ee5832
-  data.tar.gz: 313a1bad5fad409eec001adedaa0fe1b3a6149dd
+  metadata.gz: 827e1edf79b114d1ab6fbcdae8391bf4024a15ab
+  data.tar.gz: c34edbf3efc7e772a31288d1d2864468725d0bb1
 SHA512:
-  metadata.gz: 51a488e9e5a872833098ebae2be192e31c31a28277c11d959b7ac1102a180abdbc1480a8ef8e65117ab3cb52e666df8afb96b25c82277b586568b5c47f353970
-  data.tar.gz: 60ef0c4cf9b6425f5e1a468e256d8c9594958178cc6e35c91d2f96525a9719d94e7bb0664c67841285d02889dcc13c48e519d67001c296c5cc08b0c7855fef25
+  metadata.gz: 79969ca3ee1c165df5e7612378324802e03f857880455125fb6cca548f019551e03137e85b49d611de91d7b79ce0f8be7ab2936a583a0b889698aa1860eece88
+  data.tar.gz: f2b4fe0459da9f2f22a2cc3cc70bec73e48caad8601eac6eb83e4f581be0d48ab8952ece5f890c7b6c070f9f69194a04456437bac77ed9e2ad3c8f21b26ec96c

data/lib/phraseapp-ruby.rb

@@ -5,8 +5,9 @@ require 'uri'
 require 'cgi'
 require 'json'
 require 'date'
-require File.expand_path('../auth', __FILE__)
-require File.expand_path('../request_handler', __FILE__)
+require 'phraseapp-ruby/auth'
+require 'phraseapp-ruby/request_handler'
+require 'phraseapp-ruby/version'
 
 module PhraseApp
   def self.handle_times(obj)
@@ -14,7 +15,7 @@ module PhraseApp
       if is_a_date?(v)
         obj.send(:"#{k}=", DateTime.parse(v))
       end
-    end    
+    end
   end
 
   def self.is_a_date?(str)
@@ -105,22 +106,6 @@ module ResponseObjects
       end
     end
 
-    class LocaleFileImport < ::OpenStruct
-      #created_at, file_format, id, state, updated_at, 
-      def initialize(hash)
-        super(hash)
-        PhraseApp.handle_times(self)
-      end
-    end
-
-    class LocaleFileImportWithSummary < LocaleFileImport
-      #summary, 
-      def initialize(hash)
-        super(hash)
-        PhraseApp.handle_times(self)
-      end
-    end
-
     class LocalePreview < ::OpenStruct
       #code, id, name, 
       def initialize(hash)
@@ -273,6 +258,14 @@ module ResponseObjects
       end
     end
 
+    class Upload < ::OpenStruct
+      #created_at, filename, format, id, state, summary, updated_at, 
+      def initialize(hash)
+        super(hash)
+        PhraseApp.handle_times(self)
+      end
+    end
+
     class User < ::OpenStruct
       #created_at, email, id, name, position, updated_at, username, 
       def initialize(hash)
@@ -289,9 +282,18 @@ module ResponseObjects
       end
     end
 
+    class Webhook < ::OpenStruct
+      #active, callback_url, created_at, description, events, id, updated_at, 
+      def initialize(hash)
+        super(hash)
+        PhraseApp.handle_times(self)
+      end
+    end
+
   
 end
 
+
 module RequestParams
   # AuthorizationParams
   # == Parameters:
@@ -943,7 +945,7 @@ end
 
 
 module RequestParams
-  # LocaleFileImportParams
+  # UploadParams
   # == Parameters:
   # convert_emoji::
   #   Indicates whether the file contains Emoji symbols that should be converted. <a href="/guides/working-with-phraseapp/emoji-support/">Working with Emojis</a>.
@@ -961,7 +963,7 @@ module RequestParams
   #   List of tags separated by comma to be associated with the new keys contained in the upload.
   # update_translations::
   #   Indicates whether existing translations should be updated with the file content.
-  class LocaleFileImportParams < ::OpenStruct
+  class UploadParams < ::OpenStruct
     def convert_emoji=(val)
       if val.is_a?(TrueClass)
         self.convert_emoji = true
@@ -1020,7 +1022,57 @@ module RequestParams
 
     def validate
       if self.file == nil
-        raise PhraseApp::ParamsHelpers::ParamsValidationError.new("Required parameter \"file\" of \"LocaleFileImportParams\" not set")
+        raise PhraseApp::ParamsHelpers::ParamsValidationError.new("Required parameter \"file\" of \"UploadParams\" not set")
+      end
+    end
+
+    def to_h
+      @table.dup
+    end
+
+  end
+end
+
+
+module RequestParams
+  # WebhookParams
+  # == Parameters:
+  # active::
+  #   Whether webhook is active or inactive
+  # callback_url::
+  #   Callback URL to send requests to
+  # description::
+  #   Webhook description
+  # events::
+  #   List of event names to trigger the webhook (separated by comma)
+  class WebhookParams < ::OpenStruct
+    def active=(val)
+      if val.is_a?(TrueClass)
+        self.active = true
+      elsif val.is_a?(FalseClass) #ignore
+        self.active = b
+      else
+        PhraseApp::ParamsHelpers::ParamsValidationError.new("invalid value #{val}")
+      end
+    end
+
+    def callback_url=(val)
+      self.callback_url = val
+    end
+
+    def description=(val)
+      self.description = val
+    end
+
+    def events=(val)
+      self.events = val
+    end
+
+    def validate
+      if self.callback_url == nil || self.callback_url == "" 
+        raise PhraseApp::ParamsHelpers::ParamsValidationError.new("Required parameter \"callback_url\" of \"WebhookParams\" not set")
+      endif self.events == nil || self.events == "" 
+        raise PhraseApp::ParamsHelpers::ParamsValidationError.new("Required parameter \"events\" of \"WebhookParams\" not set")
       end
     end
 
@@ -3512,7 +3564,7 @@ end
       return JSON.load(rc.body).map { |item| PhraseApp::ResponseObjects::Translation.new(item) }, err
     end
   
-    # List translations for a specific locale.
+    # List translations for a specific locale. If you want to download all translations for one locale we recommend to use the <code>locales#download</code> endpoint.
     # API Path: /v2/projects/:project_id/locales/:locale_id/translations
     # == Parameters:
     # project_id::
@@ -3622,7 +3674,7 @@ end
       return PhraseApp::ResponseObjects::AffectedCount.new(JSON.load(rc.body)), err
     end
   
-    # List translations for the given project. Alternatively, POST request to /search
+    # List translations for the given project. If you want to download all translations for one locale we recommend to use the <code>locales#download</code> endpoint.
     # API Path: /v2/projects/:project_id/translations
     # == Parameters:
     # project_id::
@@ -3658,7 +3710,7 @@ end
       return JSON.load(rc.body).map { |item| PhraseApp::ResponseObjects::Translation.new(item) }, err
     end
   
-    # List translations for the given project if you exceed GET request limitations on translations list.
+    # List translations for the given project if you exceed GET request limitations on translations list. If you want to download all translations for one locale we recommend to use the <code>locales#download</code> endpoint.
     # API Path: /v2/projects/:project_id/translations/search
     # == Parameters:
     # project_id::
@@ -3772,10 +3824,10 @@ end
     # project_id::
     #   project_id
     # params::
-    #   Parameters of type PhraseApp::RequestParams::LocaleFileImportParams
+    #   Parameters of type PhraseApp::RequestParams::UploadParams
     #
     # == Returns:
-    #   PhraseApp::ResponseObjects::LocaleFileImportWithSummary
+    #   PhraseApp::ResponseObjects::Upload
     #   err
     def upload_create(project_id, params)
       path = sprintf("/api/v2/projects/%s/uploads", project_id)
@@ -3783,8 +3835,8 @@ end
       post_body = nil
   
       if params.present?
-        unless params.kind_of?(PhraseApp::RequestParams::LocaleFileImportParams)
-          raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::LocaleFileImportParams")
+        unless params.kind_of?(PhraseApp::RequestParams::UploadParams)
+          raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::UploadParams")
         end
       end
       if params.convert_emoji != nil
@@ -3833,7 +3885,7 @@ end
         return nil, err
       end
       
-      return PhraseApp::ResponseObjects::LocaleFileImportWithSummary.new(JSON.load(rc.body)), err
+      return PhraseApp::ResponseObjects::Upload.new(JSON.load(rc.body)), err
     end
   
     # View details and summary for a single upload.
@@ -3845,7 +3897,7 @@ end
     #   id
     #
     # == Returns:
-    #   PhraseApp::ResponseObjects::LocaleFileImportWithSummary
+    #   PhraseApp::ResponseObjects::Upload
     #   err
     def upload_show(project_id, id)
       path = sprintf("/api/v2/projects/%s/uploads/%s", project_id, id)
@@ -3858,7 +3910,7 @@ end
         return nil, err
       end
       
-      return PhraseApp::ResponseObjects::LocaleFileImportWithSummary.new(JSON.load(rc.body)), err
+      return PhraseApp::ResponseObjects::Upload.new(JSON.load(rc.body)), err
     end
   
     # List all uploads for the given project.
@@ -3868,7 +3920,7 @@ end
     #   project_id
     #
     # == Returns:
-    #   PhraseApp::ResponseObjects::LocaleFileImportWithSummary
+    #   PhraseApp::ResponseObjects::Upload
     #   err
     def uploads_list(project_id, page, per_page)
       path = sprintf("/api/v2/projects/%s/uploads", project_id)
@@ -3881,7 +3933,7 @@ end
         return nil, err
       end
       
-      return JSON.load(rc.body).map { |item| PhraseApp::ResponseObjects::LocaleFileImportWithSummary.new(item) }, err
+      return JSON.load(rc.body).map { |item| PhraseApp::ResponseObjects::Upload.new(item) }, err
     end
   
     # Get details on a single version.
@@ -3936,6 +3988,176 @@ end
       return JSON.load(rc.body).map { |item| PhraseApp::ResponseObjects::TranslationVersion.new(item) }, err
     end
   
+    # Create a new webhook.
+    # API Path: /v2/projects/:project_id/webhooks
+    # == Parameters:
+    # project_id::
+    #   project_id
+    # params::
+    #   Parameters of type PhraseApp::RequestParams::WebhookParams
+    #
+    # == Returns:
+    #   PhraseApp::ResponseObjects::Webhook
+    #   err
+    def webhook_create(project_id, params)
+      path = sprintf("/api/v2/projects/%s/webhooks", project_id)
+      data_hash = {}
+      post_body = nil
+  
+      if params.present?
+        unless params.kind_of?(PhraseApp::RequestParams::WebhookParams)
+          raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::WebhookParams")
+        end
+      end
+  
+      data_hash = params.to_h
+      err = params.validate
+      if err != nil
+        return nil, err
+      end
+      reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body)
+      rc, err = PhraseApp.send_request(@credentials, "POST", path, reqHelper.ctype, reqHelper.body, 201)
+      if err != nil
+        return nil, err
+      end
+      
+      return PhraseApp::ResponseObjects::Webhook.new(JSON.load(rc.body)), err
+    end
+  
+    # Delete an existing webhook.
+    # API Path: /v2/projects/:project_id/webhooks/:id
+    # == Parameters:
+    # project_id::
+    #   project_id
+    # id::
+    #   id
+    #
+    # == Returns:
+    #   err
+    def webhook_delete(project_id, id)
+      path = sprintf("/api/v2/projects/%s/webhooks/%s", project_id, id)
+      data_hash = {}
+      post_body = nil
+  
+      reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body)
+      rc, err = PhraseApp.send_request(@credentials, "DELETE", path, reqHelper.ctype, reqHelper.body, 204)
+      if err != nil
+        return nil, err
+      end
+      
+      return err
+    end
+  
+    # Get details on a single webhook.
+    # API Path: /v2/projects/:project_id/webhooks/:id
+    # == Parameters:
+    # project_id::
+    #   project_id
+    # id::
+    #   id
+    #
+    # == Returns:
+    #   PhraseApp::ResponseObjects::Webhook
+    #   err
+    def webhook_show(project_id, id)
+      path = sprintf("/api/v2/projects/%s/webhooks/%s", project_id, id)
+      data_hash = {}
+      post_body = nil
+  
+      reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body)
+      rc, err = PhraseApp.send_request(@credentials, "GET", path, reqHelper.ctype, reqHelper.body, 200)
+      if err != nil
+        return nil, err
+      end
+      
+      return PhraseApp::ResponseObjects::Webhook.new(JSON.load(rc.body)), err
+    end
+  
+    # Perform a test request for a webhook.
+    # API Path: /v2/projects/:project_id/webhooks/:id/test
+    # == Parameters:
+    # project_id::
+    #   project_id
+    # id::
+    #   id
+    #
+    # == Returns:
+    #   err
+    def webhook_test(project_id, id)
+      path = sprintf("/api/v2/projects/%s/webhooks/%s/test", project_id, id)
+      data_hash = {}
+      post_body = nil
+  
+      reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body)
+      rc, err = PhraseApp.send_request(@credentials, "POST", path, reqHelper.ctype, reqHelper.body, 200)
+      if err != nil
+        return nil, err
+      end
+      
+      return err
+    end
+  
+    # Update an existing webhook.
+    # API Path: /v2/projects/:project_id/webhooks/:id
+    # == Parameters:
+    # project_id::
+    #   project_id
+    # id::
+    #   id
+    # params::
+    #   Parameters of type PhraseApp::RequestParams::WebhookParams
+    #
+    # == Returns:
+    #   PhraseApp::ResponseObjects::Webhook
+    #   err
+    def webhook_update(project_id, id, params)
+      path = sprintf("/api/v2/projects/%s/webhooks/%s", project_id, id)
+      data_hash = {}
+      post_body = nil
+  
+      if params.present?
+        unless params.kind_of?(PhraseApp::RequestParams::WebhookParams)
+          raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::WebhookParams")
+        end
+      end
+  
+      data_hash = params.to_h
+      err = params.validate
+      if err != nil
+        return nil, err
+      end
+      reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body)
+      rc, err = PhraseApp.send_request(@credentials, "PATCH", path, reqHelper.ctype, reqHelper.body, 200)
+      if err != nil
+        return nil, err
+      end
+      
+      return PhraseApp::ResponseObjects::Webhook.new(JSON.load(rc.body)), err
+    end
+  
+    # List all webhooks for the given project.
+    # API Path: /v2/projects/:project_id/webhooks
+    # == Parameters:
+    # project_id::
+    #   project_id
+    #
+    # == Returns:
+    #   PhraseApp::ResponseObjects::Webhook
+    #   err
+    def webhooks_list(project_id, page, per_page)
+      path = sprintf("/api/v2/projects/%s/webhooks", project_id)
+      data_hash = {}
+      post_body = nil
+  
+      reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body)
+      rc, err = PhraseApp.send_request_paginated(@credentials, "GET", path, reqHelper.ctype, reqHelper.body, 200, page, per_page)
+      if err != nil
+        return nil, err
+      end
+      
+      return JSON.load(rc.body).map { |item| PhraseApp::ResponseObjects::Webhook.new(item) }, err
+    end
+  
   end
 
 end

data/lib/{request_handler.rb → phraseapp-ruby/request_handler.rb}

@@ -1,8 +1,6 @@
-require 'version'
-
 module PhraseApp
 
-  API_CLIENT_IDENTIFIER = "PhraseApp Ruby " + VERSION
+  API_CLIENT_IDENTIFIER = "PhraseApp Ruby #{VERSION}"
 
   module RequestErrors
     class ErrorResponse

data/lib/{version.rb → phraseapp-ruby/version.rb}

@@ -1,3 +1,3 @@
 module PhraseApp
-  VERSION = '1.1.2'
+  VERSION = '1.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: phraseapp-ruby
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.2.0
 platform: ruby
 authors:
 - PhraseApp
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-08 00:00:00.000000000 Z
+date: 2015-10-07 00:00:00.000000000 Z
 dependencies: []
 description: PhraseApp API client libary
 email:
@@ -17,10 +17,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/auth.rb
 - lib/phraseapp-ruby.rb
-- lib/request_handler.rb
-- lib/version.rb
+- lib/phraseapp-ruby/auth.rb
+- lib/phraseapp-ruby/request_handler.rb
+- lib/phraseapp-ruby/version.rb
 homepage: https://github.com/phrase/phraseapp-ruby
 licenses:
 - BSD
@@ -41,7 +41,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Interact with the PhraseApp API