phraseapp-ruby 1.0.13 → 1.0.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3039ead9df5cb430b9e3724285138a4bcdd624da
-  data.tar.gz: 6ed573a0c34f80284767bd48e8538d2ef46fd7db
+  metadata.gz: 058fa89f6b08b1b9f37315377a737c157c21aa9d
+  data.tar.gz: 581635c7ad2d5db9c137d00f8cb38f78cc93b3ae
 SHA512:
-  metadata.gz: 247c94438e6033536ff3ce5fa2fca0c8612351949d79936ae6520cf132ad715a848b7bcb9a7796048cd085c49ebd78e0f03be8c9e628bae1f1521f94e559d94c
-  data.tar.gz: 0015673bb21c0ecc18be90aec3b8b1422dc2ff312289b8bdc3e76ea1e4491d374b28a786162ac75681cfc6fc3c1eae3a7416e499e5044d175de26098f995b44d
+  metadata.gz: fe0998dba3662539a79f255d4d5f666bafc58152fa980696dd3bd892b04f6a51959fdc90b3e58c7505fab088e99e25196dc5c24d26fa54243cd188bb8590b714
+  data.tar.gz: 18020bf020462151be285f453a3b911827be2254489bf6f493c639ed980738f6cb1b512a1f739a57936bcafe0dfdb3a1f51704e48808bdea874132a4adfe9441

data/lib/auth.rb

@@ -4,6 +4,7 @@ module PhraseApp
 
   module Auth
 
+    # See PhraseApp::Client for usage example
     class AuthHandler < OpenStruct
       def validate
         if self.username == "" && self.token == ""
@@ -13,6 +14,7 @@ module PhraseApp
         end
       end
 
+      private
       def load_config
         path = self.config
         tmpA = AuthHandler.new
@@ -36,10 +38,14 @@ module PhraseApp
           self.tfa = tmpA.tfa
         end
 
-        if tmpA.host && self.username.nil?
+        if tmpA.host
           self.host = tmpA.host
         end
 
+        if tmpA.debug
+          self.debug = tmpA.debug
+        end
+
         return nil
       end
     end
@@ -60,6 +66,14 @@ module PhraseApp
       end
     end
 
+    def self.debug
+      if authH.debug && authH.debug != ""
+        return authH.debug
+      else
+        return false
+      end
+    end
+
     def self.authenticate(req)
       if authH == nil
         raise("no auth handler registered")

data/lib/phraseapp-ruby.rb

@@ -1026,7 +1026,7 @@ module RequestParams
   # locale_id::
   #   Locale used to determine the translation state of a key when filtering for untranslated or translated keys.
   # q::
-  #   Filter the results. Supports text queries for key name with 'name:key_name' and qualifiers like translated/untranslated 'translated:true/false'. Requires an additional <code>locale_id</code> parameter if 'translated:true/false' is used.
+  #   Specify a <a href="/api/v2/examples/#word-matching-examples">search term query</a> including wildcard or exact matching. It will search the key metadata for matching results. Searched fields include key name, description, tags, translations.<br><br> Also supports the following qualifiers in the query:<br> <ul> <li><code>name:key_name</code> for text queries on key names</li> <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li> <li><code>updated_at{>=|<=}2013-02-21</code> for date range queries</li> </ul> Find more examples <a href="/api/v2/examples/">here</a>.
   class KeysDeleteParams < ::OpenStruct
     def locale_id=(val)
       self.locale_id = val
@@ -1051,7 +1051,7 @@ module RequestParams
   # order::
   #   Order direction. Can be one of: asc, desc.
   # q::
-  #   Specify a <a href="/guides/working-with-phraseapp/search-terms">search term query</a> including wildcard or exact matching. It will search the key metadata for matching results. Searched fields include key name, description, tags, translations.<br><br> Also supports the following qualifiers in the query:<br> <ul> <li><code>name:key_name</code> for text queries on key names</li> <li><code>translated:{true|false}</code> for translation status*</li> <li><code>updated_at{>=|<=}21-02-2013</code> for date range queries</li> </ul> *Also requires <code>locale_id</code> to be specified.
+  #   Specify a <a href="/api/v2/examples/#word-matching-examples">search term query</a> including wildcard or exact matching. It will search the key metadata for matching results. Searched fields include key name, description, tags, translations.<br><br> Also supports the following qualifiers in the query:<br> <ul> <li><code>name:key_name</code> for text queries on key names</li> <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li> <li><code>updated_at{>=|<=}2013-02-21</code> for date range queries</li> </ul> Find more examples <a href="/api/v2/examples/">here</a>.
   # sort::
   #   Sort by field. Can be one of: name, created_at, updated_at.
   class KeysListParams < ::OpenStruct
@@ -1086,7 +1086,7 @@ module RequestParams
   # order::
   #   Order direction. Can be one of: asc, desc.
   # q::
-  #   Filter the results. Supports text queries for name:key_name and qualifiers translated:true/false as well as date range queries. Requires an additional <code>locale_id</code> parameter if 'translated:true/false' is used.
+  #   Specify a <a href="/api/v2/examples/#word-matching-examples">search term query</a> including wildcard or exact matching. It will search the key metadata for matching results. Searched fields include key name, description, tags, translations.<br><br> Also supports the following qualifiers in the query:<br> <ul> <li><code>name:key_name</code> for text queries on key names</li> <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li> <li><code>updated_at{>=|<=}2013-02-21</code> for date range queries</li> </ul> Find more examples <a href="/api/v2/examples/">here</a>.
   # sort::
   #   Sort by field. Can be one of: name, created_at, updated_at.
   class KeysSearchParams < ::OpenStruct
@@ -1119,7 +1119,7 @@ module RequestParams
   # locale_id::
   #   Locale used to determine the translation state of a key when filtering for untranslated or translated keys.
   # q::
-  #   Filter the results. Supports text queries for key name with 'name:key_name' and qualifiers like translated/untranslated 'translated:true/false'. Requires an additional <code>locale_id</code> parameter if 'translated:true/false' is used.
+  #   Specify a <a href="/api/v2/examples/#word-matching-examples">search term query</a> including wildcard or exact matching. It will search the key metadata for matching results. Searched fields include key name, description, tags, translations.<br><br> Also supports the following qualifiers in the query:<br> <ul> <li><code>name:key_name</code> for text queries on key names</li> <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li> <li><code>updated_at{>=|<=}2013-02-21</code> for date range queries</li> </ul> Find more examples <a href="/api/v2/examples/">here</a>.
   # tags::
   #   Tag or comma-separated list of tags to add to the matching collection of keys
   class KeysTagParams < ::OpenStruct
@@ -1150,7 +1150,7 @@ module RequestParams
   # locale_id::
   #   Locale used to determine the translation state of a key when filtering for untranslated or translated keys.
   # q::
-  #   Filter the results. Supports text queries for key name with 'name:key_name' and qualifiers like translated/untranslated 'translated:true/false'. Requires an additional <code>locale_id</code> parameter if 'translated:true/false' is used.
+  #   Specify a <a href="/api/v2/examples/#word-matching-examples">search term query</a> including wildcard or exact matching. It will search the key metadata for matching results. Searched fields include key name, description, tags, translations.<br><br> Also supports the following qualifiers in the query:<br> <ul> <li><code>name:key_name</code> for text queries on key names</li> <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li> <li><code>updated_at{>=|<=}2013-02-21</code> for date range queries</li> </ul> Find more examples <a href="/api/v2/examples/">here</a>.
   # tags::
   #   Tag or comma-separated list of tags to add to the matching collection of keys
   class KeysUntagParams < ::OpenStruct
@@ -1188,8 +1188,8 @@ module RequestParams
   #   Indicates whether keys without translations should be included in the output as well.
   # keep_notranslate_tags::
   #   Indicates whether [NOTRANSLATE] tags should be kept.
-  # tag_id::
-  #   Limit result to keys tagged with the given tag (identified by its id).
+  # tag::
+  #   Limit result to keys tagged with the given tag (identified by its name).
   class LocaleDownloadParams < ::OpenStruct
     def convert_emoji=(val)
       if val == "true"
@@ -1229,8 +1229,8 @@ module RequestParams
       end
     end
 
-    def tag_id=(val)
-      self.tag_id = val
+    def tag=(val)
+      self.tag = val
     end
 
     def validate
@@ -1297,7 +1297,7 @@ module RequestParams
   # order::
   #   Order direction. Can be one of: asc, desc.
   # q::
-  #   Filter the results. Supports text queries with the same results as in the Translation Center as well as qualifiers like unverified:true/false and date range queries.
+  #   Specify a <a href="/api/v2/examples/#word-matching-examples">search term query</a> including wildcard or exact matching. It will search the key metadata for matching results. Searched fields include key name, description, tags, translations.<br><br> Also supports the following qualifiers in the query:<br> <ul> <li><code>tags:XYZ</code> for tags on the translation</li> <li><code>unverified:{true|false}</code> for verification status</li> <li><code>updated_at{>=|<=}2013-02-21</code> for date range queries</li> </ul> Find more examples <a href="/api/v2/examples/">here</a>.
   # sort::
   #   Sort criteria. Can be one of: key_name, created_at, updated_at.
   class TranslationsByKeyParams < ::OpenStruct
@@ -1326,7 +1326,7 @@ module RequestParams
   # order::
   #   Order direction. Can be one of: asc, desc.
   # q::
-  #   Filter the results. Supports text queries with the same results as in the Translation Center as well as qualifiers like unverified:true/false and date range queries.
+  #   Specify a <a href="/api/v2/examples/#word-matching-examples">search term query</a> including wildcard or exact matching. It will search the key metadata for matching results. Searched fields include key name, description, tags, translations.<br><br> Also supports the following qualifiers in the query:<br> <ul> <li><code>tags:XYZ</code> for tags on the translation</li> <li><code>unverified:{true|false}</code> for verification status</li> <li><code>updated_at{>=|<=}2013-02-21</code> for date range queries</li> </ul> Find more examples <a href="/api/v2/examples/">here</a>.
   # sort::
   #   Sort criteria. Can be one of: key_name, created_at, updated_at.
   class TranslationsByLocaleParams < ::OpenStruct
@@ -1355,7 +1355,7 @@ module RequestParams
   # order::
   #   Order direction. Can be one of: asc, desc.
   # q::
-  #   Filter the results. Supports text queries with same results as in Translation Center and qualifiers such as unverified:true/false as well as date range queries.
+  #   Specify a <a href="/api/v2/examples/#word-matching-examples">search term query</a> including wildcard or exact matching. It will search the key metadata for matching results. Searched fields include key name, description, tags, translations.<br><br> Also supports the following qualifiers in the query:<br> <ul> <li><code>tags:XYZ</code> for tags on the translation</li> <li><code>unverified:{true|false}</code> for verification status</li> <li><code>updated_at{>=|<=}2013-02-21</code> for date range queries</li> </ul> Find more examples <a href="/api/v2/examples/">here</a>.
   # sort::
   #   Sort criteria. Can be one of: key_name, created_at, updated_at.
   class TranslationsExcludeParams < ::OpenStruct
@@ -1384,7 +1384,7 @@ module RequestParams
   # order::
   #   Order direction. Can be one of: asc, desc.
   # q::
-  #   Filter the results. Supports text queries with same results as in Translation Center and qualifiers such as unverified:true/false as well as date range queries.
+  #   Specify a <a href="/api/v2/examples/#word-matching-examples">search term query</a> including wildcard or exact matching. It will search the key metadata for matching results. Searched fields include key name, description, tags, translations.<br><br> Also supports the following qualifiers in the query:<br> <ul> <li><code>tags:XYZ</code> for tags on the translation</li> <li><code>unverified:{true|false}</code> for verification status</li> <li><code>updated_at{>=|<=}2013-02-21</code> for date range queries</li> </ul> Find more examples <a href="/api/v2/examples/">here</a>.
   # sort::
   #   Sort criteria. Can be one of: key_name, created_at, updated_at.
   class TranslationsIncludeParams < ::OpenStruct
@@ -1413,7 +1413,7 @@ module RequestParams
   # order::
   #   Order direction. Can be one of: asc, desc.
   # q::
-  #   Filter the results. Supports text queries with the same results as in the Translation Center as well as qualifiers like unverified:true/false and date range queries.
+  #   Specify a <a href="/api/v2/examples/#word-matching-examples">search term query</a> including wildcard or exact matching. It will search the key metadata for matching results. Searched fields include key name, description, tags, translations.<br><br> Also supports the following qualifiers in the query:<br> <ul> <li><code>tags:XYZ</code> for tags on the translation</li> <li><code>unverified:{true|false}</code> for verification status</li> <li><code>updated_at{>=|<=}2013-02-21</code> for date range queries</li> </ul> Find more examples <a href="/api/v2/examples/">here</a>.
   # sort::
   #   Sort criteria. Can be one of: key_name, created_at, updated_at.
   class TranslationsListParams < ::OpenStruct
@@ -1442,7 +1442,7 @@ module RequestParams
   # order::
   #   Order direction. Can be one of: asc, desc.
   # q::
-  #   Filter the results. Supports text queries with the same results as in the Translation Center as well as qualifiers like unverified:true/false and date range queries.
+  #   Specify a <a href="/api/v2/examples/#word-matching-examples">search term query</a> including wildcard or exact matching. It will search the key metadata for matching results. Searched fields include key name, description, tags, translations.<br><br> Also supports the following qualifiers in the query:<br> <ul> <li><code>tags:XYZ</code> for tags on the translation</li> <li><code>unverified:{true|false}</code> for verification status</li> <li><code>updated_at{>=|<=}2013-02-21</code> for date range queries</li> </ul> Find more examples <a href="/api/v2/examples/">here</a>.
   # sort::
   #   Sort criteria. Can be one of: key_name, created_at, updated_at.
   class TranslationsSearchParams < ::OpenStruct
@@ -1471,7 +1471,7 @@ module RequestParams
   # order::
   #   Order direction. Can be one of: asc, desc.
   # q::
-  #   Filter the results. Supports text queries with same results as in Translation Center and qualifiers such as unverified:true/false as well as date range queries.
+  #   Specify a <a href="/api/v2/examples/#word-matching-examples">search term query</a> including wildcard or exact matching. It will search the key metadata for matching results. Searched fields include key name, description, tags, translations.<br><br> Also supports the following qualifiers in the query:<br> <ul> <li><code>tags:XYZ</code> for tags on the translation</li> <li><code>unverified:{true|false}</code> for verification status</li> <li><code>updated_at{>=|<=}2013-02-21</code> for date range queries</li> </ul> Find more examples <a href="/api/v2/examples/">here</a>.
   # sort::
   #   Sort criteria. Can be one of: key_name, created_at, updated_at.
   class TranslationsUnverifyParams < ::OpenStruct
@@ -1500,7 +1500,7 @@ module RequestParams
   # order::
   #   Order direction. Can be one of: asc, desc.
   # q::
-  #   Filter the results. Supports text queries with the same results as in the Translation Center as well as qualifiers like unverified:true/false and date range queries.
+  #   Specify a <a href="/api/v2/examples/#word-matching-examples">search term query</a> including wildcard or exact matching. It will search the key metadata for matching results. Searched fields include key name, description, tags, translations.<br><br> Also supports the following qualifiers in the query:<br> <ul> <li><code>tags:XYZ</code> for tags on the translation</li> <li><code>unverified:{true|false}</code> for verification status</li> <li><code>updated_at{>=|<=}2013-02-21</code> for date range queries</li> </ul> Find more examples <a href="/api/v2/examples/">here</a>.
   # sort::
   #   Sort criteria. Can be one of: key_name, created_at, updated_at.
   class TranslationsVerifyParams < ::OpenStruct

data/lib/request_handler.rb

@@ -87,11 +87,15 @@ module PhraseApp
         path)
 
 
+    if PhraseApp::Auth.debug
+      puts "-------"
+      puts "data:"
+      puts data.inspect
+    end
 
-    puts "data:"
-    puts data.inspect
     req.body = data
 
+
     if ctype != ""
       req["Content-Type"] = ctype
     end
@@ -111,11 +115,21 @@ module PhraseApp
     req["User-Agent"] = API_CLIENT_IDENTIFIER
 
     uri = URI.parse(PhraseApp::Auth.host)
+
+    if PhraseApp::Auth.debug
+      puts "uri:"
+      puts uri.inspect
+    end
+
     http = Net::HTTP.new(uri.host, uri.port)
     http.use_ssl = true
     http.verify_mode = OpenSSL::SSL::VERIFY_PEER
-    if ENV['DEBUG']
-      puts "#{req.method} #{req.path}"
+    if PhraseApp::Auth.debug
+      puts "method:"
+      puts req.method
+      puts "path:"
+      puts req.path
+      puts "body:"
       puts req.body.inspect
       puts "-------"
     end

data/lib/version.rb

@@ -1,3 +1,3 @@
 module PhraseApp
-  VERSION = '1.0.13'
+  VERSION = '1.0.15'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: phraseapp-ruby
 version: !ruby/object:Gem::Version
-  version: 1.0.13
+  version: 1.0.15
 platform: ruby
 authors:
 - PhraseApp
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-10 00:00:00.000000000 Z
+date: 2015-07-16 00:00:00.000000000 Z
 dependencies: []
 description: PhraseApp API client libary
 email: