sraas 0.2.6 → 0.2.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7cec7776f444f2e21badf296554f2a25d5234019
-  data.tar.gz: cc3e070e3e4a05d55156f37f9ea9d6f279d5a1d1
+  metadata.gz: e0d3d3ecb8c25690c58ba8cc3f9eb258d47f63b8
+  data.tar.gz: 3324dd49bb861f7cfe71d72f5813205c075dfe75
 SHA512:
-  metadata.gz: da6f4bf03e8dfc166ce09aa4e1ef6baabbb1c421ab753033213bb5ca099a249835920f81e698e67aa58716a7dc931347351cd40a1220324755f7d5c15d10397b
-  data.tar.gz: 6ea49851946eb4623d543ffc727ee9d8ff5c0ed9d2bf33ad59e523c74e5ebe1c1ad402bced2203679d004561fd6ebe5c88e54d2aec0d7ba0f5fa9898ac2aa376
+  metadata.gz: b41000df97f948d433cb9f3cc7947d716d92eb0d6a6e33307e145bcfc25d89b93522a8445c7dde6b1d9931f1cea9185d295d67f81a81027dd6e92b0f58838837
+  data.tar.gz: 743b18a1bf3557017576be183cb32f36a24b379c6972dcb4567f2a0c1fe7cf39f4c310a9495164be69f5868e1d85d2e421e3535a5a9321c2d7e7136840c7d65f

data/README.md

@@ -23,8 +23,13 @@ $ rake sraas:install
 
 Add your api key in  `config/initializers/sraas.rb` 
 ```ruby
-# API key
-config.api_key = <API KEY>
+Sraas.configure do |config|
+  # Sraas provider URL
+  config.url         = ENV["SRAAS_URL"] || "https://www.sraas.io"
+
+  # API key
+  config.api_key     = Rails.application.secrets.sraas_api_key
+end
 ```
 
 Run migrations

data/bin/sraas

@@ -27,7 +27,12 @@ module Sraas
 
       class SraasSectet < Hanami::CLI::Command
         def use_credentials
-          Sraas.configuration.api_key = File.read(CRED)
+          if File.exist?(CRED)
+            Sraas.configuration.api_key = File.read(CRED)
+          else
+            Commands::Login.new(command_name: 'login').call
+            use_credentials
+          end
         end
       end
 
@@ -53,7 +58,7 @@ module Sraas
 
           example [SecureRandom.uuid]
 
-          def call(uuid: , **)
+          def call(uuid:, **)
             response = fetch_info(uuid)
             text = "Info for Consumer #{uuid}. "
             text += "Learns available: #{response['available_to_learn']} "
@@ -115,12 +120,12 @@ module Sraas
             def map_card(card)
               Card.new(
                 quiz_id: response['quiz_id'],
-                id: card['card_id'],
-                front: card['front'],
+                id:      card['card_id'],
+                front:   card['front'],
                 meaning: card['learn_tabs'][0]['body'],
-                prompt: card['prompt'],
+                prompt:  card['prompt'],
                 answers: card['answer'],
-                kind: card['card_type']
+                kind:    card['card_type'],
               )
             end
           end
@@ -143,7 +148,84 @@ module Sraas
               end
             end
           end
+        end
+      end
+
+      module Learn
+        class Consumer < Info::Consumer
+          desc 'Allows learning new things'
+
+          argument :uuid, desc: 'Consumer UUID'
+
+          example [SecureRandom.uuid]
+
+          def call(uuid:, **)
+            use_credentials
+            response = JSON.parse(consumer_learn(uuid))
+            response['cards'].each do |card|
+              card = OpenStruct.new({
+                id:   card['uuid'],
+                kind: card['kind'],
+                back: card['back'],
+                tabs: card['learn_tabs'],
+              })
+              print card_header(card.kind).red
+              card_body(Nokogiri::HTML(card.back.gsub('<br>', "\n")).text)
+              print card_footer.red
+              puts card_tabs(card.tabs)
+              print close.red
+              STDIN.gets
+              print "\r" + ("\e[A\e[K"*(13+format(card.tabs).size))
+            end
+          end
 
+          def card_header(kind)
+            <<~HEREDOC
+               ________________________________________________________________
+              |                                                                |
+              |                            #{kind}                             |
+              |________________________________________________________________|
+              |                                                                |
+              |                                                                |
+            HEREDOC
+          end
+
+          def card_footer
+            <<~HEREDOC
+              |                                                                |
+              |________________________________________________________________|
+              |                                                                |
+            HEREDOC
+          end
+
+          def close
+             <<~HEREDOC
+              |________________________________________________________________|
+            HEREDOC
+          end
+
+          def card_body(text)
+            radical, meaing = text.split("\n")
+            printf("%s%s%s\n", '|'.red, radical.center(63).green,'|'.red)
+            printf("%s%s%s\n", '|'.red, meaing.center(64).green,'|'.red)
+          end
+
+          def card_tabs(tabs)
+            format(tabs)
+              .map{|line| "%s%s%s" % ['|'.red, line.center(64).blue,'|'.red]}
+              .join("\n")
+          end
+
+          def format(tabs)
+            tabs
+              .map{|tab| "#{tab['title']}: #{Nokogiri::HTML(tab['body']).text}"}
+              .join("\n")
+              .scan(/\S.{1,60}(?!\S)/)
+          end
+
+          def consumer_learn(uuid)
+            Sraas.api_resource(:get, "#{consumer_url(uuid)}/learn")
+          end
         end
       end
 
@@ -164,10 +246,15 @@ module Sraas
         prefix.register 'consumer', Info::Consumer, aliases: ['c', '-c']
       end
 
+      register 'learn' do |prefix|
+        prefix.register 'consumer', Learn::Consumer, aliases: ['c', '-c']
+      end
+
       register 'review' do |prefix|
         prefix.register 'consumer', Review::Consumer, aliases: ['c', '-c']
       end
     end
   end
 end
+
 Hanami::CLI.new(Sraas::CLI::Commands).call

data/lib/sraas.rb

@@ -2,6 +2,7 @@ require 'rest_client'
 require 'sraas/consumer' if defined?(ActiveRecord::Base)
 require 'sraas/railtie' if defined?(Rails)
 require 'sraas/has_sraas' if defined?(Rails)
+require 'sraas/template_card'
 require 'sraas/configuration'
 
 module Sraas
@@ -37,6 +38,10 @@ module Sraas
       @cache = consumers.inject({}) { |a, v| k = v['id']; a[k] = v; a }
     end
 
+    def template_decks
+      JSON.parse(api_resource(:get, template_decks_endpoint))
+    end
+
     def consumers
       api_resource(:get, consumers_endpoint)
     end
@@ -53,6 +58,10 @@ module Sraas
       "#{configuration.url}/cards"
     end
 
+    def card_search_endpoint(consumer_id)
+      "#{configuration.url}/consumers/#{consumer_id}/cards/search"
+    end
+
     def template_decks_endpoint
       "#{configuration.url}/template_decks"
     end

data/lib/sraas/configuration.rb

@@ -1,10 +1,11 @@
 module Sraas
   class Configuration
-    attr_accessor :url, :api_key
+    attr_accessor :url, :api_key, :default_deck
 
     def initialize
-      @url         = 'https://www.sraas.io'
-      @api_key     = nil
+      @url          = 'https://www.sraas.io'
+      @api_key      = nil
+      @default_deck = nil
     end
   end
 end

data/lib/sraas/consumer.rb

@@ -44,7 +44,7 @@ module Sraas
 
     # Nicer accessors for binary
     def learned_anything?
-      info['first_learn_at']
+      info['learned_anything']
     end
 
     def reviewed_anything?
@@ -73,8 +73,18 @@ module Sraas
       OpenStruct.new(progress: lesson['progress'], cards: lesson['cards'])
     end
 
+    # Bulk accessor
+    def cards(card_uuids)
+      parse_json { get("#{Sraas.cards_endpoint}/bulk?#{{ids: card_uuids}.to_query}") }
+    end
+
+    # One card accessor
     def card(card_uuid)
-      parse_json { get("#{Sraas.cards_endpoint}/#{card_uuid}") }
+      parse_json { get("#{Sraas.cards_endpoint}/cards/#{card_uuid}") }
+    end
+
+    def search_card(consumer_id, title, kind)
+      parse_json { get("#{Sraas.card_search_endpoint(consumer_id)}?title=#{title}&kind=#{kind}") }
     end
 
     def report(correct_ids, incorrect_ids)
@@ -83,7 +93,7 @@ module Sraas
     end
 
     def template_decks
-      parse_json { get(Sraas.template_decks_endpoint) }
+      Sraas.template_decks
     end
 
     def unlock_lesson(lesson = 1)
@@ -107,6 +117,11 @@ module Sraas
       "#{Sraas.consumers_endpoint}/#{consumer_uuid}"
     end
 
+    def update_card(card_uuid, params = {})
+      data = patch("#{Sraas.cards_endpoint}/#{card_uuid}", params)
+      data.code == 200
+    end
+
     private
 
     def consumer
@@ -122,6 +137,10 @@ module Sraas
       Sraas.api_resource(:get, url)
     end
 
+    def patch(url, payload)
+      Sraas.api_resource(:patch, url, payload)
+    end
+
     def parse_json(&block)
       JSON.parse(block.call) if block_given?
     end

data/lib/sraas/has_sraas.rb

@@ -2,11 +2,11 @@ module Sraas
   module HasSraas
     module ClassMethods
       def has_sraas(deck: nil)
-        has_one :sraas, as: :sraas_consumerable, class_name: Sraas::Consumer
+        has_one :sraas, as: :sraas_consumerable, class_name: 'Sraas::Consumer'
 
         after_create :configure_sraas_consumer!
 
-        self.sraas_default_deck = deck
+        self.sraas_default_deck = deck || Sraas.configuration.default_deck
       end
     end
 

data/lib/sraas/template_card.rb

@@ -0,0 +1,29 @@
+module Sraas
+  class TemplateCard
+    class << self
+      def index(offset: 1, limit: 1)
+        paging = { limit: limit, offset: offset }.to_query
+        JSON.parse(Sraas.api_resource(:get, "#{template_cards_url}?#{paging}"))
+      end
+
+      def get(id)
+        JSON.parse(Sraas.api_resource(:get, "#{template_cards_url}/#{id}"))
+      end
+
+      private
+
+      def template_cards_url
+        "#{Sraas.template_decks_endpoint}/#{deck_uuid}/template_cards"
+      end
+
+      def deck_uuid
+        @deck_uuid ||= detect_deck_by_name.dig('id')
+      end
+
+      def detect_deck_by_name
+        deck_name = Sraas.configuration.default_deck
+        Sraas.template_decks.detect { |deck| deck['name'] == deck_name } || {}
+      end
+    end
+  end
+end

data/lib/sraas/version.rb

@@ -1,3 +1,3 @@
 module Sraas
-  VERSION = '0.2.6'
+  VERSION = '0.2.10'
 end

data/lib/tasks/templates/initializers/sraas.rb

@@ -1,7 +1,10 @@
 Sraas.configure do |config|
   # Sraas provider URL
-  config.url         = 'https://www.sraas.io'
+  config.url          = 'https://www.sraas.io'
 
   # API key
-  config.api_key     = nil # 'your-api-key'
+  config.api_key      = nil # 'your-api-key'
+
+  # Default deck
+  config.default_deck = nil
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sraas
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.2.10
 platform: ruby
 authors:
 - Jonathan Siegel
@@ -166,6 +166,7 @@ files:
 - lib/sraas/consumer.rb
 - lib/sraas/has_sraas.rb
 - lib/sraas/railtie.rb
+- lib/sraas/template_card.rb
 - lib/sraas/version.rb
 - lib/tasks/sraas_tasks.rake
 - lib/tasks/templates/initializers/sraas.rb
@@ -179,9 +180,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="