monkeylearn 3.1.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2ff330b7689bdc6da28cc2bf6107c5c27bbfe935
-  data.tar.gz: 2fce10b6d2503a8298c104a379e8a18a3dbc66dd
+  metadata.gz: 50b2d5b17e20cfa4c508355318a6cf08dcf2f3e0
+  data.tar.gz: 310360fa275dea689d86a46b8ddb1f88f4fdc9dc
 SHA512:
-  metadata.gz: cb4645c0ea5f9b4b9941cd17e748602bbea322885b337150f4a69276db11119cd171d90279c47fdfaea21e117eb7c78f68cc67df412420a4b82f26d8be2cc6cc
-  data.tar.gz: 0a261f78ff5283281317face0d28a905c5d5bdd7f74f51bcb828ebf253c091c41eec3a4bebcd212bea422d2083c3c6cf0aa931ac65e96d479ea5afce33672d69
+  metadata.gz: 4dc4c7abf0d7d07315af6586d963f65c551f2c26eb9c6e101c4dfad2f5bd004517cee94fc5761ef014f3eaa6a7ce766b6f14d26e23e778230cff561d4ce4b2fe
+  data.tar.gz: 6783eb1b622f2b4ad8e4f32b767519e7443d6bc69d19701a8bb045438193c700a96fe377ddb93e95c6df5441b84958fbbf989d9d60ca56b35a271854ad732f37

data/README.md

@@ -353,7 +353,7 @@ Monkeylearn.classifiers.delete('[MODEL_ID]')
 
 
 ```ruby
-Monkeylearn.classifiers.list(page: 1, per_page: 20)
+Monkeylearn.classifiers.list(page: 1, per_page: 20, order_by: '-created')
 ```
 
 Optional parameters:
@@ -362,11 +362,12 @@ Optional parameters:
 |--------------------|-------------------|-------------------|-------------|
 |*page*              |`Integer`          | `1`               | Specifies which page to get.|
 |*per_page*          |`Integer`          | `20`              | Specifies how many items per page will be returned. |
+|*order_by*          |`String or Array`  |`'-created'`       | Specifies the ordering criteria. It must be a `String` with a valid field name, if you want inverse/descending order of the field prepend a `-` (dash) character. If you want to specify more than one field send an array of such `Strings`. Some valid examples: `is_public`, `'-name'` or `['-is_public', 'name']`. |
 
 Example:
 
 ```ruby
-response = Monkeylearn.classifiers.list(page: 1, per_page: 5)
+response = Monkeylearn.classifiers.list(page: 1, per_page: 5, order_by: '-name')
 ```
 
 <br>
@@ -626,9 +627,10 @@ Parameters:
 |--------------------|-------------------|-------------------|-------------|
 |*page*              |`Integer`          | `1`               | Specifies which page to get.|
 |*per_page*          |`Integer`          | `20`              | Specifies how many items per page will be returned. |
+|*order_by*          |`String or Array`  |`'-created'`       | Specifies the ordering criteria. It must be a `String` with a valid field name, if you want inverse/descending order of the field prepend a `-` (dash) character. If you want to specify more than one field send an array of such `Strings`. Some valid examples: `is_public`, `'-name'` or `['-is_public', 'name']`. |
 
 Example:
 
 ```ruby
-response = Monkeylearn.extractors.list(page: 1)
+response = Monkeylearn.extractors.list(page: 1, order_by: '-name')
 ```

data/lib/monkeylearn/classifiers.rb

@@ -1,4 +1,5 @@
 require 'monkeylearn/requests'
+require 'monkeylearn/param_validation'
 
 module Monkeylearn
   class << self
@@ -54,7 +55,15 @@ module Monkeylearn
       end
 
       def list(options = {})
-        request(:get, build_endpoint, nil, options)
+        if options.key?(:order_by)
+          options[:order_by] = validate_order_by_param(options[:order_by])
+        end
+        query_params = {
+          page: options[:page],
+          per_page: options[:per_page],
+          order_by: options[:order_by]
+        }.delete_if { |k,v| v.nil? }
+        request(:get, build_endpoint, nil, query_params)
       end
 
       def create(name, options = {})

data/lib/monkeylearn/extractors.rb

@@ -1,4 +1,5 @@
 require 'monkeylearn/requests'
+require 'monkeylearn/param_validation'
 
 module Monkeylearn
   class << self
@@ -50,7 +51,15 @@ module Monkeylearn
       end
 
       def list(options = {})
-        request(:get, build_endpoint, nil, options)
+        if options.key?(:order_by)
+          options[:order_by] = validate_order_by_param(options[:order_by])
+        end
+        query_params = {
+          page: options[:page],
+          per_page: options[:per_page],
+          order_by: options[:order_by]
+        }.delete_if { |k,v| v.nil? }
+        request(:get, build_endpoint, nil, query_params)
       end
 
       def detail(module_id)

data/lib/monkeylearn/param_validation.rb

@@ -0,0 +1,37 @@
+def validate_order_by_param(order_by_param)
+  def validate_order_by_param_field(field_string)
+    if field_string .include? ','
+      raise MonkeylearnError, "Invalid ',' (comma) character found in 'order_by' fieldname '#{field_string}', try sending a list of strings if you need to specify multiple fields"
+    elsif field_string !~ /^-?[a-z_]+$/
+      raise MonkeylearnError, "Invalid characters found in 'order_by fieldname '#{field_string}'"
+    end
+    field_string
+  end
+
+  order_by = []
+  if order_by_param.is_a? String
+    order_by.push(validate_order_by_param_field(order_by_param))
+  elsif order_by_param.respond_to? 'each'
+    if order_by_param.length < 1
+      raise MonkeylearnError, "'order_by' parameter must be a non empty list of strings, an empty list was found"
+    end
+    seen_fields = {}
+    order_by_param.each do |order_by_field|
+      field_name = order_by_field
+      if field_name[0] == '-'
+        field_name = field_name[1..-1]
+      end
+      if seen_fields.key? field_name
+        raise MonkeylearnError, "'order_by' parameter must be a list unique field names, duplicated fields where found: '#{field_name}'."
+      end
+      seen_fields[field_name] = true
+
+      order_by.push(validate_order_by_param_field(order_by_field))
+    end
+    order_by
+  else
+    raise MonkeylearnError, "'order_by' param must be a string or a list of strings"
+  end
+
+  return order_by.join(',')
+end

data/monkeylearn.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email = ['hello@monkeylearn.com']
   spec.homepage = 'https://github.com/monkeylearn/monkeylearn-ruby'
 
-  spec.version = '3.1.0'
+  spec.version = '3.2.0'
 
   spec.add_dependency 'faraday', '>= 0.9.2', '<= 0.15.0'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: monkeylearn
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Monkeylearn
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-27 00:00:00.000000000 Z
+date: 2018-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -44,6 +44,7 @@ files:
 - lib/monkeylearn/defaults.rb
 - lib/monkeylearn/exceptions.rb
 - lib/monkeylearn/extractors.rb
+- lib/monkeylearn/param_validation.rb
 - lib/monkeylearn/requests.rb
 - lib/monkeylearn/response.rb
 - monkeylearn.gemspec