sraas 0.2.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bb03f58651fdf3061f82991e8a9b63fe153df002
+  data.tar.gz: 960f4fad513c0d59eeb558de8b2eae1ac8ac587b
+SHA512:
+  metadata.gz: 19ae79ca9b779f86c14ab7242d5e004b40fba2005217f65f0e68257e037f75ccbf1b971bdcd63c39663ab118e6400365b654e9ad53b2d31b9336527d461ae17d
+  data.tar.gz: fcb3521e82b61314923ebcb27b5b01ef3595fe16c77004fe0749e354b0560a94e5d17f622c7667a4243fb8c23be2f7c7d91dd407f3644c66ede1a958b287c06f

data/README.md

@@ -0,0 +1,59 @@
+# Straasio
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sraas'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+In rails root run instalation script
+```bash
+$ rake sraas:install
+```
+
+Add your api key in  `config/initializers/sraas.rb` 
+```ruby
+# API key
+config.api_key = <API KEY>
+```
+
+Run migrations
+```bash
+$ rake db:migrate
+```
+
+## Using
+Add to `models/user.rb` next line
+```ruby
+class User < ApplicationRecord
+  has_sraas
+end
+```
+This will create polymorphic association `sraas_consumer` which provides interface for using SRAAS API
+
+## Tests
+To run tests use
+```bash
+$ rake spec
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+cd test/dummy; bin/rails generate model Hickwall sraas_consumer_id:string
+
+# Deploy updated gem:
+gem install pkg/sraas-0.2.2.gem

data/Rakefile

@@ -0,0 +1,35 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Straasio'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+import './lib/tasks/sraas_tasks.rake'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+end

data/bin/sraas

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'sraas'
+puts Sraas.hi
+

data/lib/sraas.rb

@@ -0,0 +1,85 @@
+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/configuration'
+
+module Sraas
+  NoAPIKey = Class.new(StandardError)
+
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+
+    def sraas_consumer_info(consumer_url)
+      JSON.parse(api_resource(:get, consumer_url))
+    end
+
+    def sraas_consumer_create(email, tags = [])
+      payload = { consumer: { email: email, tags: tags.join(',') } }
+      JSON.parse(api_resource(:post, consumers_endpoint, payload))
+    end
+
+    # This function exists so an admin-like UI
+    # can query many consumer IDs at once
+    # and then access them without creating dozens of requests.
+    def sraas_consumers_cache(consumer_ids)
+      payload = { consumer_uuids: consumer_ids }
+      data = api_resource(:post, bulk_consumers_endpoint, payload)
+      consumers = JSON.parse(data)
+      @cached_at = Time.now
+      @cache = consumers.inject({}) { |a, v| k = v['id']; a[k] = v; a }
+    end
+
+    def consumers_endpoint
+      "#{configuration.url}/consumers"
+    end
+
+    def bulk_consumers_endpoint
+      "#{configuration.url}/consumers/bulk"
+    end
+
+    def cards_endpoint
+      "#{configuration.url}/cards"
+    end
+
+    def template_decks_endpoint
+      "#{configuration.url}/template_decks"
+    end
+
+    def api_resource(http_method, url, payload = {})
+      RestClient::Request
+        .execute(
+          method: http_method,
+          url: url,
+          payload: payload,
+          headers: api_header
+        )
+    end
+
+    private
+
+    def ensure_api_key
+      # TODO: Provide meaningful message what is the reason of error
+      # and explanation how to fix this
+      raise NoAPIKey unless configuration.api_key
+    end
+
+    def api_header
+      ensure_api_key
+      {
+        accept:        :json,
+        authorization: "Token token=#{configuration.api_key}",
+      }
+    end
+  end
+end
+
+if defined?(ActiveRecord::Base)
+  ActiveRecord::Base.include Sraas::HasSraas::LocalInstanceMethods
+end

data/lib/sraas/configuration.rb

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

data/lib/sraas/consumer.rb

@@ -0,0 +1,116 @@
+module Sraas
+  class Consumer < ActiveRecord::Base
+    self.table_name_prefix = 'sraas_'
+
+    belongs_to :sraas_consumerable, polymorphic: true
+
+    validates :consumer_uuid, presence: true
+
+    def review_count
+      info['available_to_review']
+    end
+
+    def learn_count
+      info['available_to_learn']
+    end
+
+    def cards_remaining
+      info['lesson_remaining_cards']
+    end
+
+    def lesson_progress
+      info['lesson_progress']
+    end
+
+    def current_lesson
+      info['current_lesson']
+    end
+
+    def cards_by_stars
+      info['cards_by_stars']
+    end
+
+    def learned_everything?
+      info['learned_everything']
+    end
+
+    def learned_anything?
+      info['learned_anything']
+    end
+
+    def next_review_at
+      Time.parse(info['next_review_at'])
+    rescue StandardError
+      'N/A'
+    end
+
+    def info
+      # Only caching for lifetime of a single request since this object may get
+      # called many times in a view...
+      return @_info if defined?(@_info)
+      @_info = consumer
+    end
+
+    def lessons
+      parse_json { get("#{consumer_url}/lessons") }
+    end
+
+    def lesson(lesson_id)
+      lesson = parse_json { get("#{consumer_url}/lessons/#{lesson_id}") }
+      OpenStruct.new(progress: lesson['progress'], cards: lesson['cards'])
+    end
+
+    def card(card_uuid)
+      parse_json { get("#{Sraas.cards_endpoint}/#{card_uuid}") }
+    end
+
+    def report(correct_ids, incorrect_ids)
+      ids = "#{correct_ids}/#{incorrect_ids}"
+      parse_json { get("#{consumer_url}/report/#{ids}") }
+    end
+
+    def template_decks
+      parse_json { get(Sraas.template_decks_endpoint) }
+    end
+
+    def unlock_lesson(lesson = 1)
+      data = get("#{consumer_url}/unlock_lesson?lesson=#{lesson}")
+      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
+      url = "#{Sraas.template_decks_endpoint}/#{deck_uuid}/add_to_consumer"
+      payload = { consumer_id: [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)
+      data.code == 200
+    end
+
+    # This is a public method to provide to views parsing JSON in JavaScript
+    def consumer_url
+      "#{Sraas.consumers_endpoint}/#{consumer_uuid}"
+    end
+
+    private
+
+    def consumer
+      # To get caching from cache prefetch
+      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
+
+    def parse_json(&block)
+      JSON.parse(block.call) if block_given?
+    end
+  end
+end

data/lib/sraas/has_sraas.rb

@@ -0,0 +1,43 @@
+module Sraas
+  module HasSraas
+    module ClassMethods
+      def has_sraas(deck: nil)
+        has_one :sraas, as: :sraas_consumerable, class_name: Sraas::Consumer
+
+        after_create :configure_sraas_consumer!
+
+        self.sraas_default_deck = deck
+      end
+    end
+
+    module LocalInstanceMethods
+      def self.included(base)
+        base.extend ClassMethods
+        base.cattr_accessor(:sraas_default_deck)
+      end
+
+      def configure_sraas_consumer!
+        create_sraas(consumer_uuid: new_consumer['id'], sraas_consumerable: self)
+        sraas&.add_template_deck_by_name(self.class.sraas_default_deck) if self.class.sraas_default_deck
+      end
+
+      def consumer_id
+        sraas&.consumer_uuid || new_consumer['id']
+      end
+
+      private
+
+      def new_consumer
+        Sraas.sraas_consumer_create(email, tags)
+      end
+
+      def tags
+        [user_tag]
+      end
+
+      def user_tag
+        "user_id=#{id}"
+      end
+    end
+  end
+end

data/lib/sraas/railtie.rb

@@ -0,0 +1,7 @@
+module Sraas
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load File.expand_path('../tasks/sraas_tasks.rake', File.dirname(__FILE__))
+    end
+  end
+end

data/lib/sraas/version.rb

@@ -0,0 +1,3 @@
+module Sraas
+  VERSION = '0.2.3'
+end

data/lib/tasks/sraas_tasks.rake

@@ -0,0 +1,37 @@
+require 'fileutils'
+
+desc 'Copies model and migration to rails app'
+namespace :sraas do
+  task :install do
+    FileUtils.cp_r(migration_path, rails_migration_path) unless migration_copied?
+    FileUtils.cp_r(initializers_path, rails_initializers_path)
+  end
+end
+
+def migration_copied?
+  Dir.glob("#{Dir.pwd}/db/migrate/*create_sraas_consumers.rb").any?
+end
+
+def rails_migration_path
+  "#{Dir.pwd}/db/migrate/#{next_migration_number}_create_sraas_consumers.rb"
+end
+
+def rails_initializers_path
+  "#{Dir.pwd}/config/initializers/sraas.rb"
+end
+
+def migration_path
+  "#{templates_path}/migrate/create_sraas_consumers.rb"
+end
+
+def initializers_path
+  "#{templates_path}/initializers/sraas.rb"
+end
+
+def templates_path
+  File.expand_path('templates', File.dirname(__FILE__))
+end
+
+def next_migration_number
+  Time.now.utc.strftime('%Y%m%d%H%M%S')
+end

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

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

data/lib/tasks/templates/migrate/create_sraas_consumers.rb

@@ -0,0 +1,12 @@
+class CreateSraasConsumers < ActiveRecord::Migration[5.0]
+  def change
+    create_table :sraas_consumers do |t|
+      t.string :consumer_uuid
+      t.integer :sraas_consumerable_id
+      t.string :sraas_consumerable_type
+      t.index [:sraas_consumerable_type, :sraas_consumerable_id], name: 'consumerable_idx'
+
+      t.timestamps
+    end
+  end
+end

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification
+name: sraas
+version: !ruby/object:Gem::Version
+  version: 0.2.3
+platform: ruby
+authors:
+- Jonathan Siegel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-07-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.6
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: More API gem than is reasonable.
+email: no@nocontact.no
+executables:
+- sraas
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- bin/sraas
+- lib/sraas.rb
+- lib/sraas/configuration.rb
+- lib/sraas/consumer.rb
+- lib/sraas/has_sraas.rb
+- lib/sraas/railtie.rb
+- lib/sraas/version.rb
+- lib/tasks/sraas_tasks.rake
+- lib/tasks/templates/initializers/sraas.rb
+- lib/tasks/templates/migrate/create_sraas_consumers.rb
+homepage: http://no.no/no
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: SRAAS.io API Gem
+test_files: []