sraas 0.2.11 → 0.2.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: '092789958c810fe7c467e3b9ce2a4ff36cd1de69'
-  data.tar.gz: abad1f249f610b9509efcfb1b74b380745b34bd8
+  metadata.gz: d407823833658ffe8b28c0f49a259741e6b9cc37
+  data.tar.gz: 5ee3444513c052742d5e517899a62857776d4b7b
 SHA512:
-  metadata.gz: 836b106e41b9d4a3d4f4dbd733b409dbeac680025dfab55491c5711b0457d1a0ce2d1e53bcb3b49d434563efaecb7d9ee1960ed92a57b709a1ba67fb7260861d
-  data.tar.gz: 4ffb93cbd3783734260826cca06f28a62a4c1f379299b6261d7f2c792b1033bbe0187ccee10e1d4a0b2d3b566a21106937834b15a1f96d9c19e2dacf6c135cda
+  metadata.gz: 5fcd44f675dc9064afaf963a25ce5a9ddcb339a39123bf3dca2bd7a5080ea160c0261cd9c46b36f9ce371f7478296b09c3e3c863453c64e6cd6fecf366d4cab2
+  data.tar.gz: b0d4f0dcbb5bb172641e3cb9b9abeb799d03aa50ca82283ac20d62c0db88ab9a813d1402c07a515014594e4762a6a256272cd44e55d45151efb97c6c0386023c

data/README.md

@@ -46,8 +46,47 @@ end
 ```
 This will create polymorphic association `sraas_consumer` which provides interface for using SRAAS API
 
+## CLI new features
+- Get template cards specified by template_deck id
+```bash
+$ sraas template_card template_cards xxxx
+```
+- Get template card specified by template_card id
+```bash
+$ sraas template_card info xxxx
+```
+- Get template card's children specified by template_card id
+```bash
+$ sraas template_card children xxxx
+```
+- Get template card's parents specified by template_card id
+```bash
+$ sraas template_card parents xxxx
+```
+- Get lesson cards specified by consumer id and lessons id
+```bash
+$ sraas cards lesson --consumer_id=xxxx --lesson_id=x
+```
+- Get card specified by card id
+```bash
+$ sraas cards info xxxx
+```
+- Get card's children specified by card id
+```bash
+$ sraas cards children xxxx
+```
+- Get card's parents specified by card id
+```bash
+$ sraas cards parents xxxx
+```
+
 ## Tests
-To run tests use
+#### Preparation
+```bash
+$ cd specs/dummy/
+$ rake db:migrate
+```
+#### Runing
 ```bash
 $ rake spec
 ```

data/bin/sraas

@@ -79,6 +79,173 @@ module Sraas
         end
       end
 
+      module Cards
+        class Search < SraasSectet
+          desc 'Searches card by consumer uuid, title, and kind'
+
+          option :title
+          option :kind
+          option :customer, aliases: ['c']
+
+          def call(**options)
+            response = fetch(options.fetch(:customer), options.fetch(:kind), options.fetch(:title))
+            puts response
+          end
+
+          def fetch(consumer_uuid, kind, title)
+            use_credentials
+            Sraas.search_card(consumer_uuid, title, kind)
+          end
+        end
+
+        class Info < SraasSectet
+          desc 'Gets card by card uuid'
+          argument :card_uuid
+
+          def call(card_uuid:, **)
+            response = fetch(card_uuid)
+            puts response
+          end
+
+          def fetch(card_uuid)
+            use_credentials
+            url = card_url(card_uuid)
+            JSON.parse(Sraas.api_resource(:get, url))
+          end
+
+          def card_url(card_uuid)
+            "#{Sraas.cards_endpoint}/#{card_uuid}"
+          end
+        end
+
+        class Children < SraasSectet
+          desc 'Gets children cards by card uuid'
+          argument :card_uuid
+
+          def call(card_uuid:, **)
+            response = fetch(card_uuid)
+            puts response
+          end
+
+          def fetch(card_uuid)
+            use_credentials
+            url = card_children_url(card_uuid)
+            JSON.parse(Sraas.api_resource(:get, url))
+          end
+
+          def card_children_url(card_uuid)
+            "#{Sraas.cards_endpoint}/#{card_uuid}/children"
+          end
+        end
+
+        class Parents < SraasSectet
+          desc 'Gets card parents by card uuid'
+          argument :card_uuid
+
+          def call(card_uuid:, **)
+            response = fetch(card_uuid)
+            puts response
+          end
+
+          def fetch(card_uuid)
+            use_credentials
+            url = card_parents_url(card_uuid)
+            JSON.parse(Sraas.api_resource(:get, url))
+          end
+
+          def card_parents_url(card_uuid)
+            "#{Sraas.cards_endpoint}/#{card_uuid}/parents"
+          end
+        end
+
+        class Lesson < Sraas::CLI::Commands::Info::Consumer
+          desc 'Gets cards for the lesson'
+          option :consumer_uuid, aliases: ['c']
+          option :lesson_id, aliases: ['l','lesson']
+
+          def call(**options)
+            response = fetch(options.fetch(:consumer_uuid),options.fetch(:lesson_id))
+            puts response
+          end
+
+          def fetch(consumer_uuid, lesson_id)
+            use_credentials
+            url = lesson_url(consumer_uuid,lesson_id)
+            JSON.parse(Sraas.api_resource(:get, url))
+          end
+
+          def lesson_url(consumer_uuid,lesson_id)
+            "#{consumer_url(consumer_uuid)}/lessons/#{lesson_id}"
+          end
+        end
+        
+        class Update < SraasSectet
+          desc 'Updates card'
+
+          option :uuid
+          option :srs_level
+          option :user_data
+          option :unlocked_at
+          option :learned_at
+          option :performance
+          option :review_available_at
+          option :deck_id
+          option :template_card_id
+
+          def call(**options)
+            use_credentials
+            result = Sraas.update_card(options.fetch(:uuid), {card: options.select {|key| key != :uuid}})
+            puts result
+          end
+        end
+      end
+
+      module TemplateCard
+        class TemplateCards < SraasSectet
+          desc 'Gets template cards by template deck id'
+          argument :template_deck_id
+
+          def call(template_deck_id:, **)
+            use_credentials
+            response = Sraas.template_cards(template_deck_id)
+            puts response
+          end
+        end
+
+        class Info < SraasSectet
+          desc 'Get template card by template card id'
+          argument :template_card_id
+
+          def call(template_card_id:, **)
+            use_credentials
+            response = Sraas.template_card(template_card_id)
+            puts response
+          end
+        end
+
+        class Children < SraasSectet
+          desc 'Get template card by template card id'
+          argument :template_card_id
+
+          def call(template_card_id:, **)
+            use_credentials
+            response = Sraas.template_card_children(template_card_id)
+            puts response
+          end
+        end
+
+        class Parents < SraasSectet
+          desc 'Get template card by template card id'
+          argument :template_card_id
+
+          def call(template_card_id:, **)
+            use_credentials
+            response = Sraas.template_card_parents(template_card_id)
+            puts response
+          end
+        end
+      end
+
       module Review
         class Consumer < Info::Consumer
           argument :uuid, desc: 'Consumer UUID'
@@ -250,6 +417,22 @@ module Sraas
         prefix.register 'consumer', Learn::Consumer, aliases: ['c', '-c']
       end
 
+      register 'cards' do |prefix|
+        prefix.register 'search', Cards::Search, aliases: ['s', '-s']
+        prefix.register 'info', Cards::Info, aliases: ['i', '-i']
+        prefix.register 'children', Cards::Children, aliases: ['c', '-c']
+        prefix.register 'parents', Cards::Parents, aliases: ['p', '-p']
+        prefix.register 'lesson', Cards::Lesson, aliases: ['l', '-l']
+        prefix.register 'update', Cards::Update
+      end
+
+      register 'template_card', aliases: ['tc', '-tc'] do |prefix|
+        prefix.register 'template_cards', TemplateCard::TemplateCards, aliases: ['tcs', '-tcs']
+        prefix.register 'info', TemplateCard::Info, aliases: ['i', '-i']
+        prefix.register 'children', TemplateCard::Children, aliases: ['c', '-c']
+        prefix.register 'parents', TemplateCard::Parents, aliases: ['p', '-p']
+      end
+
       register 'review' do |prefix|
         prefix.register 'consumer', Review::Consumer, aliases: ['c', '-c']
       end

data/lib/sraas.rb

@@ -42,10 +42,40 @@ module Sraas
       JSON.parse(api_resource(:get, template_decks_endpoint))
     end
 
+    # This returns template cards "index" json
+    def template_cards(template_deck_id)
+      JSON.parse(Sraas.api_resource(:get, "#{self.template_decks_endpoint}/#{template_deck_id}/template_cards"))
+    end
+
+    # This returns template card "full" json
+    def template_card(template_card_id)
+      JSON.parse(Sraas.api_resource(:get, "#{self.template_cards_endpoint}/#{template_card_id}"))
+    end
+
+    # This returns template card's children's "index" json
+    def template_card_children(template_card_id)
+      JSON.parse(Sraas.api_resource(:get, "#{self.template_cards_endpoint}/#{template_card_id}/children"))
+    end
+
+    # This returns template card's parent's "index" json
+    def template_card_parents(template_card_id)
+      JSON.parse(Sraas.api_resource(:get, "#{self.template_cards_endpoint}/#{template_card_id}/parents"))
+    end
+
     def consumers
       api_resource(:get, consumers_endpoint)
     end
 
+    def search_card(consumer_uuid, title, kind)
+      query = "?title=#{title}&kind=#{kind}"
+      JSON.parse(api_resource(:get, card_search_endpoint(consumer_uuid) + query))
+    end
+
+    def update_card(card_uuid, params = {})
+      response = api_resource(:patch, cards_endpoint + "/#{card_uuid}", params)
+      response.code == 200
+    end
+
     def consumers_endpoint
       "#{configuration.url}/consumers"
     end
@@ -58,14 +88,18 @@ module Sraas
       "#{configuration.url}/cards"
     end
 
-    def card_search_endpoint(consumer_id)
-      "#{configuration.url}/consumers/#{consumer_id}/cards/search"
+    def card_search_endpoint(consumer_uuid)
+      "#{configuration.url}/consumers/#{consumer_uuid}/cards/search"
     end
 
     def template_decks_endpoint
       "#{configuration.url}/template_decks"
     end
 
+    def template_cards_endpoint
+      "#{configuration.url}/template_cards"
+    end
+
     def api_resource(http_method, url, payload = {})
       RestClient::Request
         .execute(

data/lib/sraas/consumer.rb

@@ -68,6 +68,7 @@ module Sraas
       parse_json { get("#{consumer_url}/lessons") }
     end
 
+    # Get all cards "index" json for the lesson and progress
     def lesson(lesson_id)
       lesson = parse_json { get("#{consumer_url}/lessons/#{lesson_id}") }
       OpenStruct.new(progress: lesson['progress'], cards: lesson['cards'])
@@ -78,13 +79,27 @@ module Sraas
       parse_json { get("#{Sraas.cards_endpoint}/bulk?#{{ids: card_uuids}.to_query}") }
     end
 
-    # One card accessor
+    # One card accessor. This return card "full" json
     def card(card_uuid)
       parse_json { get("#{Sraas.cards_endpoint}/#{card_uuid}") }
     end
 
-    def search_card(consumer_id, title, kind)
-      parse_json { get("#{Sraas.card_search_endpoint(consumer_id)}?title=#{title}&kind=#{kind}") }
+    # Children cards accessor. This returns card children "index" json
+    def card_children(card_uuid)
+      parse_json { get("#{Sraas.cards_endpoint}/#{card_uuid}/children") }
+    end
+
+    # Parents cards accessor. This returns card parents "index" json
+    def card_parents(card_uuid)
+      parse_json { get("#{Sraas.cards_endpoint}/#{card_uuid}/parents") }
+    end
+
+    def search_card(title, kind)
+      Sraas.search_card(self.consumer_uuid, title, kind)
+    end
+
+    def update_card(card_uuid, params = {})
+      Sraas.update_card(card_uuid, params)
     end
 
     def report(correct_ids, incorrect_ids)
@@ -105,7 +120,7 @@ module Sraas
       deck_uuid = detect_deck_by_name(deck_name).dig('id')
       return false unless deck_uuid
       url = "#{Sraas.template_decks_endpoint}/#{deck_uuid}/add_to_consumer"
-      payload = { consumer_id: [consumer_uuid] }
+      payload = { consumer_id: [self.consumer_uuid] }
       # TODO: Handle a request for a deck that doesn't exist elegantly.
       # Right now this dies on the patch call:
       data = Sraas.api_resource(:patch, url, payload)
@@ -114,12 +129,7 @@ module Sraas
 
     # This is a public method to provide to views parsing JSON in JavaScript
     def consumer_url
-      "#{Sraas.consumers_endpoint}/#{consumer_uuid}"
-    end
-
-    def update_card(card_uuid, params = {})
-      data = patch("#{Sraas.cards_endpoint}/#{card_uuid}", params)
-      data.code == 200
+      "#{Sraas.consumers_endpoint}/#{self.consumer_uuid}"
     end
 
     private
@@ -137,10 +147,6 @@ 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/template_card.rb

@@ -1,7 +1,7 @@
 module Sraas
   class TemplateCard
     class << self
-      def index(offset: 1, limit: 1)
+      def index(offset: 0, limit: 100)
         paging = { limit: limit, offset: offset }.to_query
         JSON.parse(Sraas.api_resource(:get, "#{template_cards_url}?#{paging}"))
       end
@@ -10,6 +10,14 @@ module Sraas
         JSON.parse(Sraas.api_resource(:get, "#{template_cards_url}/#{id}"))
       end
 
+      def children(id)
+        JSON.parse(Sraas.api_resource(:get, "#{self.template_cards_url}/#{id}/children"))
+      end
+
+      def parents(id)
+        JSON.parse(Sraas.api_resource(:get, "#{self.template_cards_url}/#{id}/parents"))
+      end
+
       private
 
       def template_cards_url
@@ -20,6 +28,7 @@ module Sraas
         @deck_uuid ||= detect_deck_by_name.dig('id')
       end
 
+      # TODO: This should have a Sraas.io/template_decks/search?name=xxx instead of this.
       def detect_deck_by_name
         deck_name = Sraas.configuration.default_deck
         Sraas.template_decks.detect { |deck| deck['name'] == deck_name } || {}

data/lib/sraas/version.rb

@@ -1,3 +1,3 @@
 module Sraas
-  VERSION = '0.2.11'
+  VERSION = '0.2.14'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sraas
 version: !ruby/object:Gem::Version
-  version: 0.2.11
+  version: 0.2.14
 platform: ruby
 authors:
 - Jonathan Siegel