linguin 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c59595249f391eca362ace8550146028defcab40662a9d8d84c8d2ba064b739
-  data.tar.gz: 0472447d4afb70e4b3f5be9834c6c8deb5270b175c4d36c45acd47fa4c980637
+  metadata.gz: 461d92619f5fd7fac0ad19de24ba4eea626bf451efb4b873d9bfb0cd6afab741
+  data.tar.gz: bb8a97a922a53411f020f81a8760baec5e19fcb35350636a78c6a290a874e949
 SHA512:
-  metadata.gz: 41dcf5f9ed3c89e95955f81ee4e82cf171ac7704707e4cd3cb747e796b08ef69b9a5693b6e4949bd7639f6abe0234a904393a99c7ab480c008b1181a68e1cd85
-  data.tar.gz: 0a2a092184db1c9f83afd9961c3f0f55166d5f8d1e6e3880e5d4b9439ebebea6fdcebc796bb3d4ebed0e5a85787a8789d4c47dd528a820b2d01b4a342ceab7bb
+  metadata.gz: f2c55feb0ddfdd683a3e57d135039f07e1873a8c81ebfe2dd248a74e62a0f180210449f3d99d9cc520232e8bb2fdc31aa4f92ea66d91ebfba765c03a2e4a3aa0
+  data.tar.gz: 1604d947cdb234df8004a23fbc8799a70e71cdbc8714c58ed1b1571d45a03d8ab48fbe83f45c80a36030c011221856f6d015c7b3d850e53f6f4e88797a7b259c

data/.github/workflows/main.yml

@@ -1,4 +1,4 @@
-name: Ruby
+name: Tests
 
 on: [push,pull_request]
 

data/.gitignore

@@ -9,6 +9,7 @@
 /test/tmp/
 /test/version_tmp/
 /tmp/
+.gem_release.yml
 
 # Used by dotenv library to load environment variables.
 .env

data/.rubocop.yml

@@ -72,3 +72,11 @@ Style/StringChars: # (new in 1.12)
   Enabled: true
 Style/SwapValues: # (new in 1.1)
   Enabled: true
+Lint/EmptyInPattern: # (new in 1.16)
+  Enabled: true
+Style/InPatternThen: # (new in 1.16)
+  Enabled: true
+Style/MultilineInPatternThen: # (new in 1.16)
+  Enabled: true
+Style/QuotedSymbols: # (new in 1.16)
+  Enabled: true

data/README.md

@@ -1,6 +1,6 @@
 # Linguin AI Ruby wrapper
 
-[![Ruby Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://github.com/testdouble/standard) ![build](https://github.com/LinguinAI/linguin-ruby/actions/workflows/main.yml/badge.svg)
+[![Gem Version](https://badge.fury.io/rb/linguin.svg)](https://badge.fury.io/rb/linguin) ![build](https://github.com/LinguinAI/linguin-ruby/actions/workflows/main.yml/badge.svg) [![Ruby Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://github.com/testdouble/standard)
 
 This is a Ruby wrapper for the [Linguin AI](https://linguin.ai) API (see [API docs](https://linguin.ai/api-docs/v1)) providing Language Detection as a Service.
 
@@ -81,6 +81,15 @@ status.daily_limit      # => 50_000 or nil for no limit
 status.remaining_today  # => 45_500 or Float::INFINITY for unlimited
 ```
 
+### Language list
+
+You can fetch the list of supported languages:
+
+```ruby
+languages = Linguin.languages
+# => { de: ["German", "Deutsch"], ... }
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/linguin.rb

@@ -7,6 +7,7 @@ require_relative "linguin/base_response"
 require_relative "linguin/detection"
 require_relative "linguin/bulk_detection"
 require_relative "linguin/status"
+require_relative "linguin/languages"
 
 # == Linguin API wrapper module
 # Can be used as a singleton to access all API methods.
@@ -26,6 +27,9 @@ require_relative "linguin/status"
 # * number of requests today
 # * daily detection limit of your account (false for unlimited)
 # * remaining detections today (can be Infinity)
+#
+# = Linguin.languages
+# Returns the list of supported languages.
 module Linguin
   class << self
     def api_key=(api_key)
@@ -44,6 +48,10 @@ module Linguin
       default_client.status
     end
 
+    def languages
+      default_client.languages
+    end
+
     private
 
     def default_client

data/lib/linguin/client.rb

@@ -62,6 +62,11 @@ module Linguin
       Status.from_httparty(response: httparty_response)
     end
 
+    def languages
+      httparty_response = self.class.get("/languages")
+      Languages.from_httparty(response: httparty_response)
+    end
+
     private
 
     def configure_api_key(key)

data/lib/linguin/languages.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Linguin
+  # == Linguin::Languages
+  # Returns a hash of supported languages.
+  class Languages < BaseResponse
+    class << self
+      def error(code, message)
+        new do |status|
+          status.error = {
+            code: code,
+            message: message
+          }
+        end.raise_on_error!
+      end
+
+      def success(response)
+        response
+      end
+    end
+  end
+end

data/lib/linguin/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Linguin
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: linguin
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Jan Schwenzien
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-05-13 00:00:00.000000000 Z
+date: 2021-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -133,6 +133,7 @@ files:
 - lib/linguin/client.rb
 - lib/linguin/detection.rb
 - lib/linguin/exceptions.rb
+- lib/linguin/languages.rb
 - lib/linguin/status.rb
 - lib/linguin/version.rb
 - linguin.gemspec