obf 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5afc4eec32460327902d440eb155542c74c03d66
-  data.tar.gz: f07ee3b08cbd8d54a8871d899d1c706e7d11bdc2
+  metadata.gz: 3dd93aa5841bcdf4538a71b0338ab2b13f3ea674
+  data.tar.gz: c3b6ecf6cdeba8605bd34ac2a890b1e9f8345b4f
 SHA512:
-  metadata.gz: 2922588d938f988d71e032e826c89c56377d8f208edd8cbd6e082f0307d27767fed792ca10f03652cc49c6f9f6dfdf976323db91820fde343d6d9edd653edbab
-  data.tar.gz: 85c9884e240b60e9ba76de7b8b927779d20386ab640495a3e1075aefa6c412d02d5d6f150db4f3fd65ada8e7334f19ff0fc189bb2b58b01676d52fe89966e49b
+  metadata.gz: ac95324522ab772b27ded6a24215d86128b809c0b3f71cc4b08c27b15e815f948de8cb0148e67c2ab06f198e6156930b607d6c7412b7232a7d3ceb1b948d2895
+  data.tar.gz: 483a7f515b1fc3b96bb87cf335dc5d9efeb044da802d117e94450b61d49ba2addc9b91eda38b2cc7921eea8e08cdb1fb1903ba3c9965ceddaaf5d5a5fd8658c3

data/README.md

@@ -1,174 +1,22 @@
-# Canvas API
+# OBF Parser
 
-This ruby library is to make it easier to use the
-[Canvas API](http://api.instructure.com).
+This ruby library is to make it easier to handle .obf and .obz files
 
 ## Installation
-This is packaged as the `canvas-api` rubygem, so you can just add the dependency to
+This is packaged as the `obf` rubygem, so you can just add the dependency to
 your Gemfile or install the gem on your system:
 
-    gem install canvas-api
+    gem install obf
 
 To require the library in your project:
 
-    require 'canvas-api'
+    require 'obf'
 
 ## Usage
 
-### OAuth Dance
-
-Before you can make API calls you need an access token on behalf of the current user.
-In order to get an access token you'll need to do the OAuth dance (and for that you'll
-need a client_id and secret. Talk to the Canvas admin about getting these values):
-
-```ruby
-canvas = Canvas::API.new(:host => "https://canvas.example.com", :client_id => 123, :secret => "abcdef")
-url = canvas.oauth_url("https://my.site/oauth_success")
-# => "https://canvas.example.com/login/oauth2/auth?client_id=123&response_type=code&redirect_uri=http%3A%2F%2Fmy.site%2Foauth_success
-redirect to(url)
-```
-
-And then when the browser redirects to oauth_success:
-
-```ruby
-canvas = Canvas::API.new(:host => "https://canvas.example.com", :client_id => 123, :secret => "abcdef")
-code = params['code']
-canvas.retrieve_access_token(code, 'https://my.site/oauth_success') # this callback_url must match the one provided in the first step
-# => {access_token: "qwert"}
-```
-### General API Calls
-
-Once you've got an access token for a user you should save it (securely!) for future use. To use the API call:
-
-```ruby
-canvas = Canvas::API.new(:host => "https://canvas.example.com", :token => "qwert")
-canvas.get("/api/v1/users/self/profile")
-# => {id: 90210, name: "Annie Wilson", ... }
-```
-
-For POST and PUT requests the second parameter is the form parameters to append, either as a hash or
-an array of arrays:
-
 ```ruby
-canvas = Canvas::API.new(:host => "https://canvas.example.com", :token => "qwert")
-canvas.put("/api/v1/users/self", {'user[name]' => 'Dixon Wilson', 'user[short_name]' => 'Dixon'})
-# => {id: 90210, name: "Dixon Wilson", ... }
-canvas.put("/api/v1/users/self", {'user' => {'name' => 'Dixon Wilson', 'short_name' => 'Dixon'}}) # this is synonymous with the previous call
-# => {id: 90210, name: "Dixon Wilson", ... }
-canvas.put("/api/v1/users/self", [['user[name]', 'Dixon Wilson'],['user[short_name]', 'Dixon']]) # this is synonymous with the previous call
-# => {id: 90210, name: "Dixon Wilson", ... }
+OBF::PDF.from_external(data, 'my.pdf')
 ```
 
-On GET requests you can either append query parameters to the actual path or as a hashed second argument:
-
-```ruby
-canvas = Canvas::API.new(:host => "https://canvas.example.com", :token => "qwert")
-canvas.get("/api/v1/users/self/enrollments?type[]=TeacherEnrollment&type[]=TaEnrollment")
-# => [{id: 1234, course_id: 5678, ... }, {id: 2345, course_id: 6789, ...}]
-canvas.get("/api/v1/users/self/enrollments", {'type' => ['TeacherEnrollment', 'TaEnrollment']}) # this is synonymous with the previous call
-# => [{id: 1234, course_id: 5678, ... }, {id: 2345, course_id: 6789, ...}]
-```
-
-### Pagination
-
-API endpoints that return lists are often paginated, meaning they will only return the first X results
-(where X depends on the endpoint and, possibly, the per_page parameter you optionally set). To get more
-results you'll need to make additional API calls:
-
-```ruby
-canvas = Canvas::API.new(:host => "https://canvas.example.com", :token => "qwert")
-list = canvas.get("/api/v1/calendar_events?all_events=true")
-list.length
-# => 50
-list.more?
-# => true (if there's another page of results)
-list.next_page!
-# => [...] (returns the next page of results)
-list.length
-# => 100 (also concatenates the results on to the previous list, if that's more convenient)
-list.next_page!
-# => [...]
-list.length
-# => 150
-```
-
-### Additional Utilities
-
-There are also some helper methods that can make some of the other tricky parts of the Canvas API a little more approachable.
-
-#### File Uploads
-
-Uploading files ia typically a multi-step process. There are three different ways to upload
-files.
-
-Upload a file from the local file system:
-
-
-```ruby
-canvas = Canvas::API.new(:host => "https://canvas.example.com", :token => "qwert")
-canvas.upload_file_from_local("/api/v1/users/self/files", File.open("/path/to/file.jpg"), :content_type => "image/jpeg")
-# => {id: 1, display_name: "file.jpg", ... }
-```
-
-Upload a file synchronously from a remote URL:
-
-```ruby
-canvas = Canvas::API.new(:host => "https://canvas.example.com", :token => "qwert")
-canvas.upload_file_from_url("/api/v1/users/self/files", :name => "image.jpg", :size => 12345, :url => "http://www.example.com/image.jpg")
-# => {id: 1, display_name: "image.jpg", ... }
-```
-
-Upload a file asynchronouysly from a remote URL:
-
-```ruby
-canvas = Canvas::API.new(:host => "https://canvas.example.com", :token => "qwert")
-status_url = canvas.upload_file_from_url("/api/v1/users/self/files", :asynch => true, :name => "image.jpg", :size => 12345, :url => "http://www.example.com/image.jpg")
-# => "/api/v1/file_status/url"
-canvas.get(status_url)
-# => {upload_status: "pending"}
-canvas.get(status_url)
-# => {upload_status: "ready", attachment: {id: 1, display_name: "image.jpg", ... } }
-```
-
-```ruby
-canvas = Canvas::API.new(:host => "https://canvas.example.com", :token => "qwert")
-status_url = canvas.upload_file_from_url("/api/v1/users/self/files", :asynch => true, :name => "image.jpg", :size => 12345, :url => "http://www.example.com/image.jpg")
-# => "/api/v1/file_status/url"
-canvas.get(status_url)
-# => {upload_status: "errored", message: "Invalid response code, expected 200 got 404"}
-```
-
-For any of these upload types you can optionally provide additional configuration parameters if
-the upload endpoint is to an area of Canvas that supports folders (user files, course files, etc.)
-
-```ruby
-canvas = Canvas::API.new(:host => "https://canvas.example.com", :token => "qwert")
-#
-# upload the file to a known folder with id 1234
-canvas.upload_file_from_url("/api/v1/users/self/files", :parent_folder_id => 1234, :name => "image.jpg", :size => 12345, :url => "http://www.example.com/image.jpg")
-# => {id: 1, display_name: "image.jpg", ... }
-#
-# upload the file to a folder with the path "/friends"
-canvas.upload_file_from_url("/api/v1/users/self/files", :parent_folder_path => "/friends", :name => "image.jpg", :size => 12345, :url => "http://www.example.com/image.jpg")
-# => {id: 1, display_name: "image.jpg", ... }
-#
-# rename this file instead of overwriting a file with the same name (overwrite is the default)
-canvas.upload_file_from_url("/api/v1/users/self/files", :on_duplicate => "rename", :name => "image.jpg", :size => 12345, :url => "http://www.example.com/image.jpg")
-# => {id: 1, display_name: "image.jpg", ... }
-```
-
-
-
-#### SIS ID Encoding
-
-In addition to regular IDs, Canvas supports [SIS IDs](https://canvas.instructure.com/doc/api/file.object_ids.html) defined
-by other systems. Sometimes these IDs contain non-standard characters, which can cause problems when
-trying to use them via the API. In those cases you can do the following:
-
-```ruby
-sis_course_id = canvas.encode_id("sis_course_id", "r#-789")
-# => "hex:sis_course_id:72232d373839"
-canvas.get("/api/v1/courses/#{sis_course_id}/enrollments")
-# => [...]
-```
+TODO...
 

data/lib/obf/external.rb

@@ -156,7 +156,7 @@ module OBF::External
     end
     
     ['images', 'sounds'].each do |type|
-      obj[type].each do |item|
+      (obj[type] || []).each do |item|
         item['data_or_url'] = item['data']
         if !item['data_or_url'] && item['path'] && opts['zipper']
           content_type = item['content_type']

data/lib/obf/pdf.rb

@@ -48,6 +48,14 @@ module OBF::PDF
     end
   end
   
+  def self.fix_color(str)
+    @@colors ||= {}
+    return @@colors[str] if @@colors[str]
+    color = `node lib/tinycolor_convert.js "#{str}"`.strip
+    @@colors[str] = color
+    color
+  end
+  
   def self.build_page(pdf, obj, options)
     OBF::Utils.as_progress_percent(0, 1.0) do
       doc_width = 11*72 - 72
@@ -104,20 +112,22 @@ module OBF::PDF
               fill = "ffffff"
               border = "eeeeee"
               if button['background_color']
-                fill = `node lib/tinycolor_convert.js "#{button['background_color']}"`.strip
+                fill = fix_color(button['background_color'])
               end   
               if button['border_color']
-                border = `node lib/tinycolor_convert.js "#{button['border_color']}"`.strip
+                border = fix_color(button['border_color'])
               end         
               pdf.fill_color fill
               pdf.stroke_color border
               pdf.fill_and_stroke_rounded_rectangle [0, button_height], button_width, button_height, default_radius
               pdf.bounding_box([5, button_height - 5], :width => button_width - 10, :height => button_height - text_height - 5) do
-                image = obj['images_hash'][button['image_id']]
-                image_local_path = image && OBF::Utils.save_image(image, options['zipper'])
-                if image_local_path && File.exist?(image_local_path)
-                  pdf.image image_local_path, :fit => [button_width - 10, button_height - text_height - 5], :position => :center, :vposition => :center
-                  File.unlink image_local_path
+                image = (obj['images_hash'] || {})[button['image_id']]
+                if image
+                  image_local_path = image && OBF::Utils.save_image(image, options['zipper'])
+                  if image_local_path && File.exist?(image_local_path)
+                    pdf.image image_local_path, :fit => [button_width - 10, button_height - text_height - 5], :position => :center, :vposition => :center
+                    File.unlink image_local_path
+                  end
                 end
               end
               if options['pages'] && button['load_board']

data/lib/obf/utils.rb

@@ -132,7 +132,7 @@ module OBF::Utils
           hash[item['id']] = item
         end
         json["#{key}_hash"] = hash
-      else
+      elsif json["#{key}_hash"]
         array = []
         json["#{key}_hash"].each do |id, item|
           item['id'] ||= id

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: obf
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Brian Whitmer
@@ -127,7 +127,7 @@ files:
 - lib/obf/png.rb
 - lib/obf/utils.rb
 - lib/tinycolor_convert.js
-homepage: http://rubygems.org/gems/obf
+homepage: https://github.com/CoughDrop/obf
 licenses:
 - MIT
 metadata: {}