spartacus 0.2.5 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 31da9b0ec8269d6bd47177af89c7f2721723f62e
-  data.tar.gz: f35356df271699f8a20d8f10e2e01711447cec0e
+  metadata.gz: 8909709c8f35d47887eb072fccf60390bbfc0abb
+  data.tar.gz: 5148ca42930d1449b0a76348cb2ad7dec242e826
 SHA512:
-  metadata.gz: c4ac64a7fb61f7ba4aa75a17268c2e78bfef24dac1e8487294e1074d5ed79aa717f9100f5f4d2bfe857397177cee5d4d2a22a95273f9b944b92ce10c4ba20b55
-  data.tar.gz: d5889bae900be86b0060f25a643c398f6330b7d666410f0f42765a3764cacf97531a00d2baf58b10d676734441ebe40cdf3241e5a7dae829a97394e90aedc796
+  metadata.gz: 611aef4b781ac375a6c900a31509cc026d8c0aebb828e393e17bba88cd25f77628f33a91179ba5733916e4940e562f58e3c327d62a70815af00f37a81aeffc84
+  data.tar.gz: 6f8434590f93554c11aadc5c2f2f2469f062734f0df2df6ee98ff716b33b2bac07a98412b8645374079a7d28d06004d45081760e1798c8449d4dd11d9fdad149

data/README.md

@@ -15,7 +15,7 @@ gem install spartacus
 ... or add to your Gemfile
 
 ```ruby
-gem "spartacus", "~> 0.2.5"
+gem "spartacus", "~> 0.2.6"
 ```
 
 ## Usage
@@ -29,7 +29,7 @@ sc = Spartacus.new("ben@bloc.io", "gooderpassword")
 Then use the client to make requests:
 
 ```ruby
-sc.update_checkpoint(129, {name: "New Checkpint Name"})
+sc.update_checkpoint(129, {name: "New Checkpoint Name"})
 ```
 
 ## Documentation

data/lib/client/resources.rb

@@ -0,0 +1,100 @@
+require_relative 'base_client'
+
+module Resources
+  include BaseClient
+
+  # Create a resource
+  #
+  # @param options [Hash] A customizable set of options.
+  # @param name [String] Resource name.
+  # @param content [String] Resource content.
+  # @param is_public [Boolean] Resource privacy.
+  # @return [Resource] The created resource
+  # @example Create a checkpoint
+  #   Spartacus#create_resource('Real Cool Resource', 'My content')
+  def create_resource(name=nil, content=nil, is_public=false)
+    url = "#{@api_base_path}/resources/"
+
+    handle_timeouts do
+      response = self.class.post(url, headers: auth_header,
+                                body: { resource: {
+                                  name: name, content: content, is_public: is_public } })
+      convert_response(response, "resource")
+    end
+  end
+
+  # Update a resource
+  #
+  # @param id [Integer] A resource id.
+  # @param options [Hash] A customizable set of options.
+  # @option options [String] :name Resource name.
+  # @option options [String] :content Resource content.
+  # @option options [Boolean] :is_public Resource privacy.
+  # @return [Resource] The updated resource
+  # @example Update a checkpoint
+  #   Spartacus#update_resource(129, {name: 'Real Cool Resource'})
+  def update_resource(id, options={})
+    whitelist = ['name', 'content', 'is_public']
+
+    options = convert_keys(options)
+    resource_params = whitelist_params(options, whitelist)
+    url = "#{@api_base_path}/resources/#{id}"
+
+    handle_timeouts do
+      response = self.class.put(url, headers: auth_header,
+                                body: { resource: resource_params })
+      convert_response(response, "resource")
+    end
+  end
+
+  # Return tags for a resource
+  #
+  # @param id [Integer] A resource id.
+  # @return [Array] The resource's tags.
+  # @example Remove a tag from a resource
+  #   Spartacus#tags_for_resource(129)
+  def tags_for_resource(id)
+    url = "#{@api_base_path}/resources/#{id}/tags"
+
+    handle_timeouts do
+      response = self.class.post(url, headers: auth_header)
+      JSON.parse(response.body)['new_list']
+    end
+  end
+
+  # Add a tag to a resource
+  #
+  # @param id [Integer] A resource id.
+  # @param id [String] The tag to add.
+  # @return [Array] The resource's tags.
+  # @example Add a tag to a resource
+  #   Spartacus#add_tag_to_resource(129, 'android')
+  def add_tag_to_resource(id, tag)
+    tag.gsub!(" ", "_")
+    url = "#{@api_base_path}/resources/#{id}/tags"
+
+    handle_timeouts do
+      response = self.class.post(url, headers: auth_header,
+                                body: { add: tag })
+      JSON.parse(response.body)['new_list']
+    end
+  end
+
+  # Remove a tag from a resource
+  #
+  # @param id [Integer] A resource id.
+  # @param id [String] The tag to remove.
+  # @return [Array] The resource's tags.
+  # @example Remove a tag from a resource
+  #   Spartacus#remove_tag_from_resource(129, 'android')
+  def remove_tag_from_resource(id, tag)
+    tag.gsub!(" ", "_")
+    url = "#{@api_base_path}/resources/#{id}/tags"
+
+    handle_timeouts do
+      response = self.class.post(url, headers: auth_header,
+                                body: { remove: tag })
+      JSON.parse(response.body)['new_list']
+    end
+  end
+end

data/lib/spartacus.rb

@@ -4,6 +4,7 @@ require 'json'
 require_relative 'client/alumni_stories'
 require_relative 'client/checkpoints'
 require_relative 'client/course_subjects'
+require_relative 'client/resources'
 require_relative 'client/roadmap_sections'
 require_relative 'client/users'
 
@@ -16,6 +17,7 @@ class Spartacus
   include RoadmapSections
   include AlumniStories
   include CourseSubjects
+  include Resources
 
   def initialize(email, password, api_base_path="https://www.bloc.io/api/v1")
     @api_base_path = api_base_path

data/spartacus.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'spartacus'
-  s.version     = '0.2.5'
+  s.version     = '0.2.7'
   s.files         = `git ls-files`.split($\)
   s.executables   = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   s.test_files    = s.files.grep(%r{^(test|spec|features)/})
@@ -15,9 +15,9 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'httparty', '~>0.13.7'
   s.add_runtime_dependency 'activesupport', '~>4.2'
   s.add_runtime_dependency 'json', '~>1.8'
-  s.add_development_dependency "bundler"
-  s.add_development_dependency "rspec"
-  s.add_development_dependency "rake"
-  s.add_development_dependency "vcr"
-  s.add_development_dependency "webmock"
+  s.add_development_dependency 'bundler', '~>1.10'
+  s.add_development_dependency 'rspec', '~> 0'
+  s.add_development_dependency 'rake', '~>10.4'
+  s.add_development_dependency 'vcr', '~>2.9'
+  s.add_development_dependency 'webmock', '~>1.22'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spartacus
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.7
 platform: ruby
 authors:
 - Ben Neely
@@ -56,72 +56,72 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.10'
 - !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: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.4'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.9'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.22'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.22'
 description: A client for the Bloc API
 email: ben@bloc.to
 executables: []
@@ -139,6 +139,7 @@ files:
 - lib/client/checkpoints.rb
 - lib/client/class_factory.rb
 - lib/client/course_subjects.rb
+- lib/client/resources.rb
 - lib/client/roadmap_sections.rb
 - lib/client/users.rb
 - lib/spartacus.rb