happyscribe 1.0.1 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3fbadf723020774ce535efd248fe63c04d66751d9f9d6bc57129bf3c5e21e1d6
-  data.tar.gz: 86790401aef3db69a4562f2a0c4b93ded42426e1bac92ef61f62f6fad5fc9463
+  metadata.gz: de5530dba1327e61cc5c8e14dc49a5267d02f8d8b5281cf5ab8603b63966c699
+  data.tar.gz: 503bab852d4b9e9cb064a4c7859a8237b064380f717fb7a4b54511815329a4e1
 SHA512:
-  metadata.gz: fb0b6bca6c4c91f9d59be447836d2f7b8746a45da86a7eff912d261dea96532ac2075fa42744217fb3826b6a5f322fed680e107b591faacef0b19b980a59d4af
-  data.tar.gz: '048f865ed843ad7f6a5b9573bfe450d8b6d6ceda681d80013c5682e67809f8b7291c170c98b5e2f9d3c5ad23bbdffa976df4aa600898375a89753d923de66bf5'
+  metadata.gz: a847552ceefabf48688c375f8a874f5d519e2a65944a344953e4fa4228a95d9fc1ebf1d8f970fea6d0224a52243be990fcb19857d8f2db37050b320616a12316
+  data.tar.gz: 193778eeb0f75b70dcf68dd1394b17caa7c46e6e640646bfa2a6cf3afb126daa2eb6caca3f5a9d3b47ac83cbe0ac3075e9130addab9d9985cea25bf82dcd240b

data/Gemfile.lock

@@ -7,7 +7,7 @@ GEM
   remote: https://rubygems.org/
   specs:
     diff-lcs (1.4.4)
-    rake (10.5.0)
+    rake (13.0.1)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -28,7 +28,7 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 2.0)
   happyscribe!
-  rake (~> 10.0)
+  rake (~> 13.0)
   rspec (~> 3.0)
 
 BUNDLED WITH

data/README.md

@@ -1,5 +1,5 @@
 # Happyscribe client for Ruby
-This is a very basic NON-OFFICIAL gem based on the happyscribes api (https://dev.happyscribe.co/). It works out of the box and makes the usage of the api much easier ;-)
+This is a small NON-OFFICIAL gem based on happyscribes api (https://dev.happyscribe.co/). It works out of the box and makes the usage of the api much easier ;-)
 
 ## dependencies
 because no one love to have 10k of dependencies, this gem uses only: net/http,uri,json and securerandom. so do not worry about the size of the gem.
@@ -29,43 +29,61 @@ require "happyscribe"
 ```
 
 ### nota bene
-all the functions sends you back a parsed json (array) with the response of the api.
+all the functions send you back a parsed json (array) with the response of the api.
 
 ### some Ruby please !
 create an instance:
 ```ruby
 instance = Happyscribe::Transcript.new(my_api_token)
+#return nothing
 ```
+
+#### API
 create a transcription.  you can use all of the avaiable language codes (https://dev.happyscribe.co/#languages)
 ```ruby
-instance.create(public_url_to_audio,"fr-FR")
+response = instance.create(public_url_to_audio,"fr-FR")
+#return: dictionnary with the id,.... (the id is the only thing that matter)
 ```
 Good to know: if you are working with ActiveStorage, you can create a public_url with url_for()
 
 retrieve all the transcriptions
 ```ruby
-instance.list
+response = instance.list
+#return: a dictionnary with a key "results" where all the transcriptions are listed
 ```
-retrieve all a transcription
+retrieve a transcription
 ```ruby
 instance.retrieve(transcription_id)
+#return: a dictionnary with everything about the transcriptions (status,....)
 ```
 create an export
 ```ruby
-instance.create_export(transcription_id, format,show_speakers,show_comments,show_highlights)
+response = instance.create_export(transcription_id, format,show_speakers,show_comments,show_highlights)
 # by default, format="txt", show_speakers,show_comments,... = false
 # so you can just do
-instance.create_export(transcription_id, format)
+response = instance.create_export(transcription_id, format)
+#return: a dictionnary with the id of the export and other informations. NB: you can't list all the exports, so do not lose the id ;-)
 ```
 
 retrieve an export
 ```ruby
 instance.retrieve_export(export_id)
+#return: a dictionnary , with a link to an attachment that you can download.
+```
+
+#### Magic function
+because we only want to have a string of the transcription, there is a function that creates the export, retrieve the export when it's ready, download the attachment and return it in utf-8. 
+
+```ruby
+instance.export_in_txt(transcription_id)
+#return: a string with the transcription
 ```
+
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/happyscribe. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/jbd0101/happyscribe. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
+you can always star the project ;) 
 
 ## License
 

data/happyscribe.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["jean-christophe bauduin"]
   spec.email         = [""]
 
-  spec.summary       = %q{Very simple ruby gem for the transcription api of happyscribe}
-  spec.description   = %q{the api of happyscribe is quite verbose, this ruby gem make it more easy to use (I hope so)}
+  spec.summary       = %q{ruby gem for the api of happyscribe}
+  spec.description   = %q{the api of happyscribe is quite verbose, this ruby gem make it easy ! take a look at the documentation on github ( https://github.com/jbd0101/happyscribe-client ) }
   spec.homepage      = "https://github.com/jbd0101/happyscribe-client"
   spec.license       = "MIT"
 
@@ -29,6 +29,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
 end

data/lib/happyscribe.rb

@@ -94,6 +94,31 @@ module Happyscribe
       end
       return JSON.parse response.body
     end
+    def create_multiple_export(ids,format="txt",timestamps=false,speakers=false,comments=false,highlights=false)
+      uri = URI.parse("#{@base}/exports")
+      request = Net::HTTP::Post.new(uri)
+      request.content_type = "application/json"
+      request["Authorization"] = @auth
+      request.body = JSON.dump({
+        "export" => {
+          "format" => format,
+          "show_timestamps" => timestamps,
+          "show_speakers" => speakers,
+          "show_comments" => comments,
+          "show_highlights" => highlights,
+          "transcription_ids" => ids
+        }
+      })
+
+      req_options = {
+        use_ssl: uri.scheme == "https",
+      }
+
+      response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
+        http.request(request)
+      end
+      return JSON.parse response.body
+    end
     def retrieve_export(export_id)
       endpoint = "#{@base}/exports/#{export_id}"
       uri = URI.parse(endpoint)
@@ -109,20 +134,24 @@ module Happyscribe
       end
       return JSON.parse response.body
     end
-    def export_in_txt(export_id)
-      export = create_export(export_id,"txt")["id"]
-      sleep(5)
-      while true
-        retrieved = retrieve_export(export)
-        if(retrieved["state"]=="ready")
-          break
-        else
-          sleep(2)
+    def export_in_txt(transcription_id)
+      transcription = retrieve transcription_id
+      if(transcription["state"]=="automatic_done")
+        export = create_export(transcription_id,"txt")["id"]
+        sleep(5)
+        while true
+          retrieved = retrieve_export(export)
+          if(retrieved["state"]=="ready")
+            break
+          else
+            sleep(2)
+          end
         end
+        txt = URI.parse(retrieved["download_link"]).open.read.force_encoding("utf-8")
+        return txt
+      else
+        raise "The transcription is not ready"
       end
-      txt = URI.parse(retrieved["download_link"]).open.read.force_encoding("utf-8")
-      return txt
-
     end
   end
 end

data/lib/happyscribe/version.rb

@@ -1,3 +1,3 @@
 module Happyscribe
-  VERSION = "1.0.1"
+  VERSION = "1.0.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: happyscribe
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.3
 platform: ruby
 authors:
 - jean-christophe bauduin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-30 00:00:00.000000000 Z
+date: 2020-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -52,8 +52,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: the api of happyscribe is quite verbose, this ruby gem make it more easy
-  to use (I hope so)
+description: 'the api of happyscribe is quite verbose, this ruby gem make it easy
+  ! take a look at the documentation on github ( https://github.com/jbd0101/happyscribe-client
+  ) '
 email:
 - ''
 executables: []
@@ -73,6 +74,8 @@ files:
 - bin/setup
 - happyscribe-0.2.0.gem
 - happyscribe-1.0.0.gem
+- happyscribe-1.0.1.gem
+- happyscribe-1.0.2.gem
 - happyscribe.gemspec
 - lib/happyscribe.rb
 - lib/happyscribe/version.rb
@@ -102,5 +105,5 @@ requirements: []
 rubygems_version: 3.0.4
 signing_key: 
 specification_version: 4
-summary: Very simple ruby gem for the transcription api of happyscribe
+summary: ruby gem for the api of happyscribe
 test_files: []