craftar 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5d6ac3e86d4425c064d13ebff2762a2a13d52cd4
+  data.tar.gz: 272c0ca83bfbcdb592013d1b0202ac3f44ad308f
+SHA512:
+  metadata.gz: 18ff4f41ef8447926484fbe020c9440e455db77d2e837b81092d124e4ea0fdadd2e04fe120678d47246b6005dc1b4dbbcc27890bf0ec152364797ffb60cb87d6
+  data.tar.gz: c170a93e46aa299187e4ea08784970d15a0a11790e13ea5dd09454f0e3c10d7c09e821d8b8b7b650e23df3f1594bc5e64b827fa0b00effa072dfc97576783da1

data/lib/craftar.rb

@@ -0,0 +1,9 @@
+require 'craftar/base'
+require 'craftar/collection'
+require 'craftar/item'
+require 'craftar/image'
+require 'craftar/token'
+require 'craftar/media'
+module Craftar
+  class << self; attr_accessor :api_key; end
+end

data/lib/craftar/base.rb

@@ -0,0 +1,101 @@
+# The main Craftar class
+module Craftar
+  class Base
+    include HTTMultiParty
+    base_uri 'https://my.craftar.net/api/v0'
+
+    # List the objects of the described class
+
+    # options: 'limit', 'offset'and any object specific option (see README)
+    # To manage the pagination, all responses have a ‘meta’ field
+    # The "meta" fields are:
+    # - total_count: total number of objects in the underlying object list
+    # - limit: how many objects are returned per page. By default it’s 20.
+    # - offset: how many initial objects are skipped in this response
+    # - previous: if available, provides a URI to the previous page
+    # - next: if available, provides a URI to the next page
+    # Fetching a page To navigate through pages, use the ‘limit‘ and ‘offset‘ parameters.
+    # The objects of the current page are in the 'objects' fields
+    def self.list(opts = {})
+      response = parse_response(get("/#{craftar_name}/", basic_options.merge(opts)))
+      raise (response ['error']['message']) if response['error']
+      objects = []
+      response['objects'].each do |object|
+        objects << self.new(object.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo})
+      end
+      response[:objects] =  objects
+      response.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
+    end
+
+    # Find an object thanks to its uuid
+    def self.find(uuid)
+      response = parse_response(get("/#{craftar_name}/#{uuid}", basic_options))
+      return if response == {}
+      self.new(response.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo})
+    end
+
+    # create a new object
+    # options are the different specific parameters of this object.
+    # See readme
+    def self.create(options)
+      obj = self.new(options)
+      obj.save
+    end
+
+    # destroy an object
+    def destroy
+      self.class.delete("/#{self.class.craftar_name}/#{uuid}/", self.class.basic_options)
+    end
+
+    private
+
+    # the basic query option
+    def self.basic_options
+      { query: { api_key: Craftar.api_key } }
+    end
+
+    def call(method_name, opts)
+      response = self.class.send(method_name,
+                      "/#{self.class.craftar_name}/",
+                      query: { api_key: Craftar.api_key }.merge!(opts)
+      )
+      raise (response ['error']['message']) if response['error']
+      response
+    end
+
+    def json_call(method_name, opts)
+      uid = opts.delete(:uuid)
+      path = "/#{self.class.craftar_name}/"
+      path += "#{uid}/" if uid
+      path += "?api_key=#{Craftar.api_key}"
+      response = self.class.parse_response( HTTParty.send(
+        method_name,
+        self.class.base_uri + path,
+        body: opts.to_json,
+        headers: { 'Content-Type' => 'application/json' }
+      ))
+      raise response ['error']['message'] if response['error']
+      response
+    end
+
+    def self.parse_response(httparty)
+      response_body = httparty.response.body
+      response_body.to_s != '' ? JSON.parse(response_body) : {}
+    end
+
+    def prepare_file_from_url(url)
+      require 'open-uri'
+      extname = File.extname(url)
+      basename = File.basename(url, extname)
+
+      file = Tempfile.new([basename, extname])
+      file.binmode
+
+      open(URI.parse(url)) do |data|
+        file.write data.read
+      end
+      file.rewind
+      file
+    end
+  end
+end

data/lib/craftar/collection.rb

@@ -0,0 +1,27 @@
+module Craftar
+  class Collection < Craftar::Base
+    attr_reader :uuid, :name, :resource_uri
+    def self.craftar_name
+      'collection'
+    end
+
+    def initialize(opts)
+      @name = opts[:name]
+      @uuid = opts[:uuid]
+      @resource_uri = opts[:resource_uri]
+    end
+
+    def save
+      response = json_call(:post, name: @name)
+      @uuid = response['uuid']
+      @resource_uri = response['resource_uri']
+      self
+    end
+
+    def update(opts)
+      response = json_call(:put, { uuid: @uuid, name: opts[:name] }.select { |_, value| !value.nil? })
+      @name = response['name']
+      self
+    end
+  end
+end

data/lib/craftar/image.rb

@@ -0,0 +1,33 @@
+module Craftar
+  class Image < Craftar::Base
+    attr_reader :uuid, :item, :resource_uri, :file, :name, :status, :thumb_120, :thumb_60, :tracking_data_status
+
+    def self.craftar_name
+      'image'
+    end
+
+    def initialize(opts)
+      set_attributes(opts)
+    end
+
+    def save
+      response = call(:post, file: prepare_file_from_url(@file), item: item)
+      set_attributes(response)
+      self
+    end
+
+    private
+
+    def set_attributes(opts)
+      @uuid = opts['uuid'] || opts[:uuid]
+      @item = opts['item'] || opts[:item]
+      @file = opts['file'] || opts[:file]
+      @resource_uri = opts['resource_uri'] || opts[:resource_uri]
+      @name = opts['name'] || opts[:name]
+      @status = opts['status'] || opts[:status]
+      @thumb_120 = opts['thumb_120'] || opts[:thumb_120]
+      @thumb_60 = opts['thumb_60'] || opts[:thumb_60]
+      @tracking_data_status = opts['tracking_data_status'] || opts[:tracking_data_status]
+    end
+  end
+end

data/lib/craftar/item.rb

@@ -0,0 +1,53 @@
+module Craftar
+  class Item < Craftar::Base
+    attr_reader :uuid, :name, :collection, :url, :content, :custom, :trackable, :resource_uri
+    def self.craftar_name
+      'item'
+    end
+
+    def initialize(opts)
+      @name = opts[:name]
+      @collection = opts[:collection]
+      @url = opts[:url]
+      @content = opts[:content]
+      @custom = opts[:custom]
+      @trackable = opts[:trackable]
+      @uuid = opts[:uuid]
+      @resource_uri = opts[:resource_uri]
+    end
+
+    def save
+      response = json_call(
+        :post,
+        {
+         name: @name,
+         collection: @collection,
+         trackable: @trackable,
+         content: @content
+        }
+      )
+      @uuid = response['uuid']
+      @resource_uri = response['resource_uri']
+      self
+    end
+
+    def update(opts)
+      options = {
+        name: opts[:name],
+        collection: opts[:collection],
+        url: opts[:url],
+        content: opts[:content],
+        custom: opts[:custom],
+        trackable: opts[:trackable]
+      }.select { |_, value| !value.nil? }
+      response = json_call(:put, { uuid: @uuid }.merge(options))
+      @name = response['name']
+      @collection = response['collection']
+      @url = response['url']
+      @content = response['content']
+      @custom = response['custom']
+      @trackable = response['trackable']
+      self
+    end
+  end
+end

data/lib/craftar/media.rb

@@ -0,0 +1,27 @@
+module Craftar
+  class Media < Craftar::Base
+    attr_reader :uuid, :file, :resource_uri, :name, :mimetype
+
+    def self.craftar_name
+      'media'
+    end
+
+    def initialize(opts)
+      @uuid = opts[:uuid]
+      @file = opts[:file]
+      @resource_uri = opts[:resource_uri]
+      @name = opts[:name]
+      @mimetype = opts[:mimetype]
+    end
+
+    def save
+      response = call(:post, file: prepare_file_from_url(@file))
+      @uuid = response['uuid']
+      @file = response['file']
+      @resource_uri = response['resource_uri']
+      @name = response['name']
+      @mimetype = response['mimetype']
+      self
+    end
+  end
+end

data/lib/craftar/token.rb

@@ -0,0 +1,29 @@
+module Craftar
+  class Token < Craftar::Base
+    attr_reader :token, :resource_uri, :collection
+    def self.craftar_name
+      'token'
+    end
+
+    def initialize(opts)
+      @collection = opts[:collection]
+      @token = opts[:token]
+      @resource_uri = opts[:resource_uri]
+    end
+
+    def save
+      response = json_call(:post, collection: @collection)
+      @token = response['token']
+      @resource_uri = response['resource_uri']
+      self
+    end
+
+    def find(token)
+      raise 'You cannot find a token'
+    end
+
+    def destroy
+      self.class.delete("/token/#{@token}/", self.class.basic_options)
+    end
+  end
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: craftar
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Marieke Gueye
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: httmultiparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.16
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.16
+description: " Ruby client that supports all of the Craftar CraftAR API methods. Intuitive
+  query methods allow you easily call API endpoints. "
+email: marieke.gueye@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/craftar.rb
+- lib/craftar/base.rb
+- lib/craftar/collection.rb
+- lib/craftar/image.rb
+- lib/craftar/item.rb
+- lib/craftar/media.rb
+- lib/craftar/token.rb
+homepage: https://github.com/mkou/craftar
+licenses:
+- MIT
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Ruby client for the official Craftar CraftAR Management API
+test_files: []