Relationship support for CTB objects

Author: Sebastian Wilgosz

Gemfile.lock

@@ -2,15 +2,24 @@ PATH
   remote: .
   specs:
     creatubbles (0.0.1)
+      activesupport
       oauth2 (>= 1.3.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (5.0.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    concurrent-ruby (1.0.4)
     diff-lcs (1.2.5)
     faraday (0.10.1)
       multipart-post (>= 1.2, < 3)
+    i18n (0.8.0)
     jwt (1.5.6)
+    minitest (5.10.1)
     multi_json (1.12.1)
     multi_xml (0.6.0)
     multipart-post (2.0.0)
@@ -35,6 +44,9 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.5.0)
     rspec-support (3.5.0)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
 
 PLATFORMS
   ruby

creatubbles.gemspec

@@ -14,6 +14,7 @@ spec = Gem::Specification.new do |s|
   s.license = 'MIT'
 
   s.add_dependency('oauth2', '>= 1.3.0')
+  s.add_dependency('activesupport')
 
   s.files = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- test/*`.split("\n")

lib/creatubbles/base_object.rb

@@ -1,5 +1,13 @@
+require 'active_support/core_ext/module/attribute_accessors'
+
 class Creatubbles::BaseObject
 
+  def self.inherited(subclass)
+    subclass.mattr_reader :attributes, :relationships
+    subclass.class_variable_set(:@@attributes, [])
+    subclass.class_variable_set(:@@relationships, [])
+  end
+
   def self.define_type_name(type_name)
     @type_name = type_name
     Creatubbles.register_type_object_class(type_name, self)
@@ -11,6 +19,8 @@ def self.type_name
 
   def self.define_attributes(atts)
     atts.each do |att|
+      raise "Duplicated attribute: #{attr}" if attributes.include?(att.to_sym)
+      attributes << att.to_sym
       class_eval <<-EOM, __FILE__, __LINE__ + 1
         def #{att}
           @data['attributes']['#{att}']
@@ -19,6 +29,25 @@ def #{att}
     end
   end
 
+  def self.define_relationships(relations)
+    relations.each do |k, v|
+      raise "Duplicated relationship: #{k}" if relationships.include?(k.to_sym)
+      relationships << k.to_sym
+      class_eval <<-EOM, __FILE__, __LINE__ + 1
+        def #{k}
+          relationship = @data['relationships']['#{k}']
+          return nil unless relationship.is_a?(Hash)
+          case (relationship_data = relationship['data']).class.name
+          when 'Hash'
+            relationship_data['id']
+          when 'Array'
+            relationship_data.map { |relation| relation['id'] }
+          end
+        end
+      EOM
+    end
+  end
+
   def initialize(connection, data)
     @connection = connection
     @data = data

lib/creatubbles/creation.rb

@@ -1,7 +1,6 @@
 require "creatubbles/base_object"
 
 class Creatubbles::Creation < Creatubbles::BaseObject
-
   define_type_name 'creations'
   define_attributes %w[
     name
@@ -28,6 +27,8 @@ class Creatubbles::Creation < Creatubbles::BaseObject
     updated_at
   ]
 
+  define_relationships %w[user creators]
+
   def update_tags(tags)
     @connection.put("creations/#{id}", :body => { 'data' => { 'type' => 'creations', 'attributes': {'tags' => tags }}})
   end

lib/creatubbles/user.rb

@@ -4,19 +4,37 @@ class Creatubbles::User < Creatubbles::BaseObject
 
   define_type_name 'users'
   define_attributes %w[
-    name
-    email
+    username
     display_name
-    creations_count
+    list_name
+    name
+    role
+    age
+    gender
+    country_code
+    country_name
+    avatar_url
+    short_url
+    added_bubbles_count
+    activities_count
     bubbles_count
     comments_count
+    creations_count
+    creators_count
+    galleries_count
+    managers_count
     last_bubbled_at
     last_commented_at
-    short_url
+    signed_up_as_instructor
+    what_do_you_teach
+    interests
+    home_schooling
     created_at
     updated_at
   ]
 
+  define_relationships %w[school custom_style]
+
   def creators
     res = @connection.get("users/#{id}/creators")
     Creatubbles.instantiate_objects_from_response(res, @connection)

spec/creatubbles/creation_spec.rb

@@ -0,0 +1,41 @@
+require 'helper'
+
+describe Creatubbles::Creation do
+  let(:client) { Creatubbles::Client.new }
+
+  let(:connection) do
+    token = { access_token: "sample", token_type: "bearer", created_at: 1479918313 }
+    OAuth2::AccessToken.from_hash(client, token)
+  end
+
+  subject { Creatubbles::Creation.new(connection, creation_json['data']) }
+
+  describe '.type_name' do
+    it "should return proper type" do
+      expect(Creatubbles::Creation.type_name).to eq 'creations'
+    end
+  end
+
+  describe 'attributes' do
+    it 'attributes list should be accessible from class and from object' do
+      subject.attributes == Creatubbles::Creation.attributes
+    end
+
+    Creatubbles::Creation.attributes.each do |attr|
+      it 'should return proper attributes' do
+        expect(subject).to respond_to(attr)
+        expect(subject.send(attr)).to eq(creation_json['data']['attributes'][attr.to_s])
+      end
+    end
+  end
+
+  describe 'relationships' do
+    it 'should include user id' do
+      expect(subject.user).to eq 'xUt6Feou'
+    end
+
+    it 'should include creator_ids' do
+      expect(subject.creators).to eq ['xUt6Feou']
+    end
+  end
+end

spec/creatubbles/user_spec.rb

@@ -0,0 +1,41 @@
+require 'helper'
+
+describe Creatubbles::User do
+  let(:client) { Creatubbles::Client.new }
+
+  let(:connection) do
+    token = { access_token: "sample", token_type: "bearer", created_at: 1479918313 }
+    OAuth2::AccessToken.from_hash(client, token)
+  end
+
+  subject { Creatubbles::User.new(connection, creation_json['data']) }
+
+  describe '.type_name' do
+    it "should return proper type" do
+      expect(Creatubbles::User.type_name).to eq 'users'
+    end
+  end
+
+  describe 'attributes' do
+    it 'attributes list should be accessible from class and from object' do
+      subject.attributes == Creatubbles::User.attributes
+    end
+
+    Creatubbles::User.attributes.each do |attr|
+      it 'should return proper attributes' do
+        expect(subject).to respond_to(attr)
+        expect(subject.send(attr)).to eq(creation_json['data']['attributes'][attr.to_s])
+      end
+    end
+  end
+
+  describe 'relationships' do
+    it 'should include user id' do
+      expect(subject.school).to be_nil
+    end
+
+    it 'should include creator_ids' do
+      expect(subject.custom_style).to be_nil
+    end
+  end
+end

spec/helper.rb

@@ -10,9 +10,7 @@
   config.expect_with :rspec do |c|
     c.syntax = :expect
   end
-end
-
 
-RSpec.configure do |conf|
-  include CreationJson
+  config.include CreationJson
+  config.include UserJson
 end

spec/support/creation_json.rb

@@ -0,0 +1,74 @@
+module CreationJson
+  def creation_json
+    {
+      "data"=>{
+        "id"=>"XIeQuGLw",
+        "type"=>"creations",
+        "attributes"=> creation_json_attributes,
+        "relationships"=>{
+          "user"=>{ "data"=>{ "id"=>"xUt6Feou", "type"=>"users" } },
+          "creators"=>{
+            "data"=>[
+              { "id"=>"xUt6Feou", "type"=>"users" }
+            ]
+          },
+          "partner_application"=>{ "data"=>nil }
+        }
+      },
+      "included"=>[
+        {
+          "id"=>"xUt6Feou",
+          "type"=>"users",
+          "attributes"=> user_json_attributes,
+          "relationships"=>{
+            "school"=>{ "data"=>nil },
+            "custom_style"=> { "data"=>{ "id"=>"3584", "type"=>"custom_styles"} }
+          }
+        }
+      ],
+      "meta"=>{ "abilities"=>[], "user_bubbled_creations"=>[], "followed_users"=>[] }
+    }
+  end
+
+  def creation_json_attributes
+    {
+      'name' => 'A boat',
+      "translated_names"=>[
+        { "code"=>"en", "name"=>"A boat", "original"=>true }
+      ],
+      "image"=>{
+        "links"=>{
+          "original"=>"https://api.creatubbles.com/v2/creation/XIeQuGLw/original/boat.jpg",
+          "full_view"=>"https://api.creatubbles.com/v2/creation/XIeQuGLw/full_view/boat.jpg",
+          "gallery_mobile"=>"https://api.creatubbles.com/v2/creation/XIeQuGLw/gallery_mobile/boat.jpg",
+          "list_view_retina"=>"https://api.creatubbles.com/v2/creation/XIeQuGLw/list_view_retina/boat.jpg",
+          "share"=>"https://api.creatubbles.com/v2/creation/XIeQuGLw/share/boat.jpg",
+          "list_view"=>"https://api.creatubbles.com/v2/creation/XIeQuGLw/list_view/boat.jpg",
+          "matrix_view_retina"=>"https://api.creatubbles.com/v2/creation/XIeQuGLw/matrix_view_retina/boat.jpg",
+          "matrix_view"=>"https://api.creatubbles.com/v2/creation/XIeQuGLw/matrix_view/boat.jpg",
+          "explore_mobile"=>"https://api.creatubbles.com/v2/creation/XIeQuGLw/explore_mobile/boat.jpg"
+        }
+      },
+      "image_status"=>3,
+      "approved"=>true,
+      "approval_status"=>"approved",
+      "created_at_age"=>"at 14y",
+      "created_at_age_per_creator"=>{"xUt6Feou"=>nil},
+      "reflection_text"=> 'My reflection',
+      "reflection_video_url"=>nil,
+      "play_iframe_url"=>nil,
+      "obj_file_url"=>nil,
+      "bubbles_count"=>1,
+      "comments_count"=>0,
+      "views_count"=>5,
+      "last_bubbled_at"=>"2017-01-25T14:07:54.202+01:00",
+      "last_commented_at"=>nil,
+      "last_submitted_at"=>nil,
+      'short_url' => "https://ctbl.es/XIeQuGLw",
+      "content_type"=>"video/quicktime",
+      "tags" => [ 'School', 'Animals' ],
+      "created_at"=>"2017-01-23T16:24:08.112+01:00",
+      "updated_at"=>"2017-01-25T14:07:54.252+01:00"
+      }
+  end
+end

spec/support/user_json.rb

@@ -0,0 +1,51 @@
+module UserJson
+  def user_json
+    {
+      "data"=> {
+        "id"=>"xUt6Feou",
+        "type"=>"users",
+        "attributes"=> user_json_attributes,
+        "relationships"=>{
+          "school"=>{ "data"=>nil },
+          "custom_style"=>{ "data"=>{ "id"=>"525", "type"=>"custom_styles" } }
+        }
+      }
+    }
+  end
+
+  def user_json_attributes
+    {
+      "username"=>"teacher098260598",
+      "display_name"=>"teacher098260598",
+      "list_name"=>"teacher098260598 (@teacher098260598)",
+      "name"=>"teacher098260598",
+      "role"=>"instructor",
+      "avatar_url"=>"https://d3fll5fltyv3n9.cloudfront.net/users/72057/creations/33535/matrix_view_retina/1485185089creation.jpg",
+      "age"=>"",
+      "gender"=>"unknown",
+      "last_bubbled_at"=>"2017-01-23T19:04:24.045Z",
+      "last_commented_at"=>nil,
+      "activities_count"=>2,
+      "comments_count"=>0,
+      "followed_users_count"=>0,
+      "creators_count"=>6,
+      "galleries_count"=>0,
+      "managers_count"=>0,
+      "short_url"=>"https://staging.ctbl.es/teacher098260598",
+      "what_do_you_teach"=>nil,
+      "interests"=>nil,
+      "country_code"=>"PL",
+      "country_flag_url"=>"https://d2r48com4t2oyq.cloudfront.net/assets/country-4x3/pl-c4d5935a0981cf8a0ac04a9f873cc2f9e2f15a8cf8ba0682e6f56f1000db6556.svg",
+      "created_at"=>"2017-01-23T12:44:50.021Z",
+      "updated_at"=>"2017-01-25T13:08:01.177Z",
+      "connected_users_count"=>5,
+      "is_young_creator"=>false,
+      "country_name"=>"Poland",
+      "signed_up_as_instructor"=>true,
+      "home_schooling"=>true,
+      "bubbles_count"=>2,
+      "added_bubbles_count"=>1,
+      "creations_count"=>1
+    }
+  end
+end