sraas 0.2.15 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8c84427806dfb1071fd9c71d0ca8cb5d45b65a95
-  data.tar.gz: 7cbe469cc7a2ca08663eab5b6eb8c4ec9a599fbc
+  metadata.gz: 5535a413f64093a0d029eb47a9cbcb4bc179f984
+  data.tar.gz: 753c6a3829882d916a06860be38ab9dc998ffcc2
 SHA512:
-  metadata.gz: dccff92b0b9a51c4ecfad6bed55bb35c87c790cef5971ee06b96981d6c3ce92f7b1f5e9ace06843f01614ad4a0c91f03aeca58c2872f38f544fc9144ebe1f1e7
-  data.tar.gz: d89e0af70d6ef41055535686027d58f50185a9a6a639b527ce50b977356e8fe83668301dcf4c91c5878326810eb5b4ee10719e85820eb3a3b39208c0936fba79
+  metadata.gz: a786a111a9f168134f01d368c645548842d5d79f402c99109233d9e005acef24d55b2c17b0d462b7c2a9e7938b5f877bf9f0f501db3cb4f53bc2a2aef67437cc
+  data.tar.gz: 7812c4976ee15f0002b8dec076e41e659174eabf43458b7206060a577285cc4b89a78cdca527721ef1f06ab5ebb426361ddcf41f07bd83a61803a78b3c623504

data/lib/sraas.rb

@@ -8,6 +8,7 @@ require 'sraas/configuration'
 module Sraas
   NoAPIKey = Class.new(StandardError)
   DeckNotFound = Class.new(StandardError)
+  DeckNotSpecified = Class.new(StandardError)
 
   class << self
     def configuration
@@ -38,8 +39,11 @@ 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))
+    # this will return all template_decks without params.(expecting to search with name_start and fingerprint_start)
+    # params can be fingerprint: if you want exact match or fingerprint_start: if you want beginning match...
+    # e.g. {name_start: "Pandanese", fingerprint_start: "abcd"} or {name: "Pandanese v1.8"}
+    def template_decks(params={})
+      JSON.parse(api_resource(:get, template_decks_endpoint, params))
     end
 
     def template_deck(id)
@@ -47,11 +51,13 @@ module Sraas
     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"))
+    def template_cards(template_deck_id:, offset: 0, limit: 100)
+      paging = { limit: limit, offset: offset }.to_query
+      JSON.parse(Sraas.api_resource(:get, "#{self.template_decks_endpoint}/#{template_deck_id}/template_cards", paging))
     end
 
     # This returns template card "full" json
+    # TODO: make this return OpenStruct when we update consumer#card
     def template_card(template_card_id)
       JSON.parse(Sraas.api_resource(:get, "#{self.template_cards_endpoint}/#{template_card_id}"))
     end
@@ -70,9 +76,10 @@ module Sraas
       api_resource(:get, consumers_endpoint)
     end
 
+    # TODO: accept not only title and kind. sraas needs to use ransack for it.
     def search_card(consumer_uuid, title, kind)
-      query = "?title=#{title}&kind=#{kind}"
-      JSON.parse(api_resource(:get, card_search_endpoint(consumer_uuid) + query))
+      params = {title: title, kind: kind}
+      JSON.parse(api_resource(:get, card_search_endpoint(consumer_uuid), params))
     end
 
     def update_card(card_uuid, params = {})

data/lib/sraas/configuration.rb

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

data/lib/sraas/consumer.rb

@@ -80,6 +80,7 @@ module Sraas
     end
 
     # One card accessor. This return card "full" json
+    # TODO: make this return OpenStruct.
     def card(card_uuid)
       parse_json { get("#{Sraas.cards_endpoint}/#{card_uuid}") }
     end
@@ -124,8 +125,18 @@ module Sraas
       OpenStruct.new(progress: template_lesson['progress'], template_cards: template_lesson['template_cards'])
     end
 
-    def template_decks
-      Sraas.template_decks
+    # TODO: accept not only title and kind. sraas needs to use ransack for it.
+    # This search template_card with title and kind.
+    def search_template_card(title, kind)
+      template_deck_id = template_deck['id']
+      url = "#{Sraas.template_decks_endpoint}/#{template_deck_id}/template_cards/search"
+      params = {title: title, kind: kind}
+      JSON.parse(Sraas.api_resource(:get, url, params))
+    end
+
+    # return all template_decks without name and fingerprint
+    def template_decks(params={})
+      Sraas.template_decks(params)
     end
 
     def unlock_lesson(lesson = 1)
@@ -133,9 +144,20 @@ module Sraas
       data.code == 200
     end
 
-    def add_template_deck_by_name(deck_name)
-      deck_uuid = detect_deck_by_name(deck_name).dig('id')
-      return false unless deck_uuid
+    # This needs to return boolean since this is called in has_sraas#add_default_deck which
+    # is expecting true or false from this method.
+    def add_template_deck(name=nil, fingerprint: nil)
+      # At least one of either name or fingerprint has to be provided.
+      fail(Sraas::DeckNotSpecified) if name.nil? && fingerprint.nil?
+
+      # Try all search patterns with name and fingerprint
+      # in case one of them is incorrect, but the other correct
+      matching_decks = Sraas.template_decks({name_start: name, fingerprint_start: fingerprint})
+      matching_decks = Sraas.template_decks({fingerprint_start: fingerprint}) unless matching_decks.any?
+      matching_decks = Sraas.template_decks({name_start: name}) unless matching_decks.any?
+      return false unless matching_decks.any?
+
+      deck_uuid = matching_decks.last['id']
       url = "#{Sraas.template_decks_endpoint}/#{deck_uuid}/add_to_consumer"
       payload = { consumer_id: [self.consumer_uuid] }
       # TODO: Handle a request for a deck that doesn't exist elegantly.
@@ -156,10 +178,6 @@ module Sraas
       Sraas.sraas_consumer_info(consumer_url)
     end
 
-    def detect_deck_by_name(deck_name)
-      template_decks.detect { |deck| deck['name'] == deck_name } || {}
-    end
-
     def get(url)
       Sraas.api_resource(:get, url)
     end

data/lib/sraas/has_sraas.rb

@@ -1,19 +1,25 @@
 module Sraas
   module HasSraas
     module ClassMethods
-      def has_sraas(deck: nil)
+      def has_sraas(name: nil, fingerprint: nil, deck: nil)
+        if deck # v1.0 Syntax
+          puts "[DEPRECATION WARNING] Since GEM 0.3.0, semantics changed for has_sraas. You probably want to say has_sraas name: ..."
+          name ||= deck # Be nice for now...
+        end
         has_one :sraas, as: :sraas_consumerable, class_name: 'Sraas::Consumer'
 
         after_create :configure_sraas_consumer!
 
-        self.sraas_default_deck = deck || Sraas.configuration.default_deck
+        self.sraas_default_deck_name = name || Sraas.configuration.default_deck_name
+        self.sraas_default_deck_fingerprint = fingerprint || Sraas.configuration.default_deck_fingerprint
       end
     end
 
     module LocalInstanceMethods
       def self.included(base)
         base.extend ClassMethods
-        base.cattr_accessor(:sraas_default_deck)
+        base.cattr_accessor(:sraas_default_deck_name)
+        base.cattr_accessor(:sraas_default_deck_fingerprint)
       end
 
       def configure_sraas_consumer!
@@ -28,16 +34,25 @@ module Sraas
       private
 
       def add_deck
-        return true if specified_deck.nil?
-        specified_deck && add_default_deck
+        return true unless specified_deck?
+        add_default_deck
       end
 
       def add_default_deck
-        sraas.add_template_deck_by_name(specified_deck)
+        sraas.add_template_deck(specified_deck_name, fingerprint: specified_deck_fingerprint)
       end
 
-      def specified_deck
-        self.class.sraas_default_deck
+      # This returns nil or non-nil if deck is specified with name or fingerprint
+      def specified_deck?
+        self.class.sraas_default_deck_name || self.class.sraas_default_deck_fingerprint
+      end
+
+      def specified_deck_name
+        self.class.sraas_default_deck_name
+      end
+
+      def specified_deck_fingerprint
+        self.class.sraas_default_deck_fingerprint
       end
 
       def new_consumer

data/lib/sraas/version.rb

@@ -1,3 +1,3 @@
 module Sraas
-  VERSION = '0.2.15'
+  VERSION = '0.3.0'
 end

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

@@ -5,6 +5,8 @@ Sraas.configure do |config|
   # API key
   config.api_key      = nil # 'your-api-key'
 
-  # Default deck
-  config.default_deck = nil
+  # Default deck name
+  config.default_deck_name = nil
+  # Default deck fingerptint
+  config.default_deck_fingerprint = nil
 end

metadata

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