plate_api 0.4.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 516481a1cbc16f2e26dcd8319b5b682c4f729217ff1f21f48f885ea7ca3f6f74
-  data.tar.gz: 6a5c9663a2185531bbb67b0f2c6a1c55941359ec233a14957ae7855ee83ed2a9
+  metadata.gz: 47fb3d26ae744fae7daf830907607587c1978be77029fa8d4cade526edeeccfe
+  data.tar.gz: 2f3e0817b62ee8f7bd344785adc353b12fb9189c539925ba7da7f181ede52246
 SHA512:
-  metadata.gz: 2a1894b50e1398d7ada99a89411a51ceadac86c564b3b6556c3491bfcd6c40a1058490d9f6e5dc360b917f238589e312ceb3d255c0b57f2cfdbbd447905be8ae
-  data.tar.gz: 6a71e32bfa9e55a080a8c06286b3c48b9d82c26961bcf280b69da1005309b409d2f3d1c889839053eb134b0173af060ebd8def0d959b4585711656493897f920
+  metadata.gz: b8a9bba6f6bc0582813b0df46d5a72d3f5de015e4bb5dcbf66bcd52fc043bb354db6bba5e9d2379160f0fbc96c3077d43914094ef8d3c09572381a1b8e4e8788
+  data.tar.gz: f66601a98fad886c26a10106697ea5c0632f423513581fce78431cfa094d97e980e04b83acb89a8a0917d90041ebde34c28cf7b215a1b2afcd7f6c9bc166b544

data/.byebug_history

@@ -0,0 +1,43 @@
+c
+attributes
+m
+c
+attributes
+m
+c;m
+m
+c
+m
+c
+attributes
+s
+up
+s
+up
+s
+new_object.attributes
+c
+new_object.attributes
+new_object
+c
+full_path
+c
+n
+val.is_a? File
+val
+c
+val.is_a? File
+val
+parameters
+c
+site.id
+site = subject.find(5)
+c
+site.class.superclass
+site.class.methods
+site.class
+site.methods.class
+site.methods - Object.methods
+site.methods
+site.id
+site = subject.find(5)

data/.gitignore

@@ -9,3 +9,5 @@
 
 # rspec failure tracking
 .rspec_status
+coverage
+/secrets

data/.travis.yml

@@ -1,5 +1,16 @@
+
+env:
+  global:
+    - CC_TEST_REPORTER_ID=5ad5ab58c1dde153aed2f4ed1ca671baa6d34530eb18a0c421fcb7bab89338e6
 sudo: false
 language: ruby
 rvm:
   - 2.5.1
 before_install: gem install bundler -v 1.16.1
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+script: bundle exec rake spec
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/Gemfile.lock

@@ -1,19 +1,43 @@
 PATH
   remote: .
   specs:
-    plate_api (0.4.0)
+    plate_api (1.0.0)
       faraday (~> 0.15.4)
       faraday_middleware (~> 0.13.1)
+      mimemagic (~> 0.3.3)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (5.2.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    addressable (2.6.0)
+      public_suffix (>= 2.0.2, < 4.0)
+    ansi (1.5.0)
+    byebug (11.0.0)
+    concurrent-ruby (1.1.4)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
     diff-lcs (1.3)
+    docile (1.3.1)
+    factory_bot (5.0.1)
+      activesupport (>= 4.2.0)
     faraday (0.15.4)
       multipart-post (>= 1.2, < 3)
     faraday_middleware (0.13.1)
       faraday (>= 0.7.4, < 1.0)
+    hashdiff (0.3.8)
+    hirb (0.7.3)
+    i18n (1.5.3)
+      concurrent-ruby (~> 1.0)
+    json (2.1.0)
+    mimemagic (0.3.3)
+    minitest (5.11.3)
     multipart-post (2.0.0)
+    public_suffix (3.0.3)
     rake (10.5.0)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
@@ -28,15 +52,37 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.0)
+    safe_yaml (1.0.5)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-console (0.4.2)
+      ansi
+      hirb
+      simplecov
+    simplecov-html (0.10.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    webmock (3.5.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler (~> 1.16)
+  byebug
+  factory_bot (~> 5.0.1)
   plate_api!
   rake (~> 10.0)
   rspec (~> 3.0)
+  simplecov
+  simplecov-console
+  webmock (~> 3.0)
 
 BUNDLED WITH
    1.16.1

data/README.md

@@ -1,8 +1,12 @@
+![Gem](https://img.shields.io/gem/dt/plate_api.svg)
+[![Gem Version](https://badge.fury.io/rb/plate_api.svg)](https://badge.fury.io/rb/plate_api)
+[![Build Status](https://travis-ci.com/platehub/plate_api.svg?branch=master)](https://travis-ci.com/platehub/plate_api)
+[![Maintainability](https://api.codeclimate.com/v1/badges/1e1dafadc880983ce63a/maintainability)](https://codeclimate.com/github/platehub/plate_api/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/1e1dafadc880983ce63a/test_coverage)](https://codeclimate.com/github/platehub/plate_api/test_coverage)
 # PlateApi
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/plate_api`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Welcome to the PlateApi gem. This gem provides a wrapper to communicate with the Plate API, taking care of
+authentication.
 
 ## Installation
 
@@ -20,9 +24,28 @@ Or install it yourself as:
 
     $ gem install plate_api
 
-## Usage
+## Getting started
+
+To get started with a simple connector:
+
+```
+# Initialze a connector
+con == PlateApi::Connector.new("{{public_key}}", "{{secret_key}}")
+
+# Find information of a specific site with id == 822
+site = con.sites.find(822)
 
-TODO: Write usage instructions here
+# Find all posts in this site
+posts = site.posts
+
+# Find all elements in the first post of this site
+first_post = posts.first
+elements = first_post.elements
+
+# Update the content field 'body' of the first element
+element = elements.first
+element.update(body: "<h2>My new text</h2>")
+```
 
 ## Development
 
@@ -30,10 +53,6 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/plate_api.
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/plate_api/connector.rb

@@ -1,32 +1,58 @@
-require "plate_api/get_request"
-require "plate_api/delete_request"
-require "plate_api/post_request"
-require "plate_api/put_request"
-
 module PlateApi
   class Connector
 
-
     def initialize(public_key, secret_key, custom_server=nil)
       @custom_server = custom_server
       @public_key = public_key
       @secret_key = secret_key
+      @handling_classes = {}
+    end
+
+    def get(url="", parameters={}, response_type=:json)
+      GetRequest.new(@public_key, @secret_key, url, parameters, @custom_server).execute(response_type)
+    end
+
+    def delete(url="", parameters={}, response_type=:json)
+      DeleteRequest.new(@public_key, @secret_key, url, parameters, @custom_server).execute(response_type)
     end
 
-    def get(url="", parameters={})
-      GetRequest.new(@public_key, @secret_key, url, parameters, @custom_server).send
+    def put(url="", put_params={}, response_type=:json)
+      PutRequest.new(@public_key, @secret_key, url, put_params, @custom_server).execute(response_type)
     end
 
-    def delete(url="", parameters={})
-      DeleteRequest.new(@public_key, @secret_key, url, parameters, @custom_server).send
+    def post(url="", post_params={}, response_type=:json)
+      PostRequest.new(@public_key, @secret_key, url, post_params, @custom_server).execute(response_type)
     end
 
-    def put(url="", put_params={})
-      PutRequest.new(@public_key, @secret_key, url, put_params, @custom_server).send
+    def post_multipart(url="", post_params={}, response_type=:json)
+      PostMultipartRequest.new(@public_key, @secret_key, url, post_params, @custom_server).execute(response_type)
     end
 
-    def post(url="", post_params={})
-      PostRequest.new(@public_key, @secret_key, url, post_params, @custom_server).send
+    def handler(handled_class)
+      @handling_classes[handled_class] ||= ObjectHandler.new(handled_class, self)
     end
+
+    def self.plate_object_classes
+      {
+        sites: PlateApi::PlateObject::Site,
+        partners: PlateApi::PlateObject::Partner,
+        companies: PlateApi::PlateObject::Company,
+        themes: PlateApi::PlateObject::Theme,
+        site_translations: PlateApi::PlateObject::SiteTranslation,
+        posts: PlateApi::PlateObject::Post,
+        sections: PlateApi::PlateObject::Section,
+        rows: PlateApi::PlateObject::Row,
+        columns: PlateApi::PlateObject::Column,
+        elements: PlateApi::PlateObject::Element
+      }
+    end
+
+    self.plate_object_classes.each do |k,v|
+      define_method(k) do
+        return handler(v)
+      end
+    end
+
+
   end
 end

data/lib/plate_api/delete_request.rb

@@ -1,5 +1,3 @@
-require "plate_api/request"
-
 module PlateApi
   class DeleteRequest < Request
     def initialize(public_key, secret, path, parameters={}, custom_server=nil)

data/lib/plate_api/get_request.rb

@@ -1,5 +1,3 @@
-require "plate_api/request"
-
 module PlateApi
   class GetRequest < Request
     def initialize(public_key, secret, path, parameters={}, custom_server=nil)

data/lib/plate_api/object_handler.rb

@@ -0,0 +1,110 @@
+module PlateApi
+  class ObjectHandler
+
+    attr_reader :api_connector
+    attr_reader :handling_class
+
+    def initialize(handling_class, api_connector)
+      raise ArgumentError.new("`handling_class` given for #new is not valid") unless handling_class
+      raise ArgumentError.new("`api_connector` given for #new is not valid") unless api_connector
+      @handling_class = handling_class
+      @api_connector = api_connector
+    end
+
+    def find(id)
+      raise ArgumentError.new("`id` given for #find is not valid") unless id
+      result = @api_connector.get(resource_path(id))
+      if result["data"]
+        return new_object(result["data"])
+      else
+        puts "No result: #{result}"
+        return nil
+      end
+    end
+
+    def update(id, attributes)
+      raise ArgumentError.new("`id` given for #update is not valid") unless id
+      raise ArgumentError.new("`attributes` given for #update is not valid") unless attributes.is_a? Hash
+      result = @api_connector.put(resource_path(id), {"data" => attributes})
+
+      if result["data"]
+        return new_object(result["data"])
+      else
+        puts "No result: #{result}"
+        return nil
+      end
+    end
+
+    def create(parent, attributes, create_method=:post)
+      raise ArgumentError.new("`parent` given for #create is not valid") unless parent
+      raise ArgumentError.new("`attributes` given for #create is not valid") unless attributes.is_a? Hash
+      parameters = case create_method
+      when :post
+        {"data" => attributes}
+      when :post_multipart
+        attributes
+      end
+
+      result = @api_connector.send(create_method, collection_path(parent.class, parent.id), parameters)
+
+      if result["data"]
+        return new_object(result["data"])
+      else
+        puts "No result: #{result}"
+        return nil
+      end
+    end
+
+    def delete(id)
+      raise ArgumentError.new("`id` given for #find is not valid") unless id
+      result = @api_connector.delete(resource_path(id))
+      if result["data"]
+        return new_object(result["data"])
+      else
+        puts "No result: #{result}"
+        return nil
+      end
+    end
+
+    def index(parent_class, parent_id)
+      raise ArgumentError.new("`parent_id` given for #index is not valid") unless parent_id
+      raise ArgumentError.new("`parent_class` given for #index is not valid") unless parent_class
+
+      result = @api_connector.get(collection_path(parent_class, parent_id))
+      if result["data"]
+        return result["data"].map{|x| new_object(x)}
+      else
+        puts "No result: #{result}"
+        return nil
+      end
+    end
+
+    private
+
+    # Construct a new object of @handling_class, given a succesful api_response
+    def new_object(api_response)
+      @handling_class.new(
+        api_response["id"],
+        api_response["attributes"],
+        api_response["relations"],
+        self
+      )
+    end
+
+    def resource_path(id)
+      "#{@handling_class.api_name}/#{id}"
+    end
+
+    def collection_path(parent_class=nil, parent_id=nil)
+      if (parent_class != nil) ^ (parent_id != nil)
+        raise ArgumentError.new("An invalid combination `parent_class` and `parent_id` is given. Provide both or none.")
+      end
+
+      if parent_class
+        "#{parent_class.api_name}/#{parent_id}/#{@handling_class.api_name}"
+      else
+        "#{@handling_class.api_name}"
+      end
+    end
+  end
+end

data/lib/plate_api/plate_object/attachment.rb

@@ -0,0 +1,18 @@
+module PlateApi::PlateObject
+  class Attachment < Base
+
+    has_one :site, "PlateApi::PlateObject::Site"
+
+    def download
+      @object_handler.api_connector.get("attachments/#{@id}/download", {}, :raw)
+    end
+
+    def self.api_name
+      "attachments"
+    end
+
+    def self.parent_class
+      Site
+    end
+  end
+end

data/lib/plate_api/plate_object/base.rb

@@ -0,0 +1,117 @@
+module PlateApi::PlateObject
+  class Base
+    attr_reader :id, :attributes, :relations
+    attr_accessor :object_handler
+
+    HasOneRelations = {}
+    HasManyRelations = {}
+
+    def initialize(id, attributes, relations, object_handler=nil)
+      @id = id
+      @object_handler = object_handler
+      initialize_state(attributes, relations)
+    end
+
+    def api_name
+      self.class.api_name
+    end
+
+    def reload
+      raise ArgumentError.new("No object_handler is set.") unless @object_handler
+      reinitialize(@object_handler.find(@id))
+      return self
+    end
+
+    def update(attributes)
+      raise ArgumentError.new("Input `attributes` is not a Hash") unless attributes.is_a? Hash
+      raise ArgumentError.new("No object_handler is attached to this object") unless @object_handler
+      if new_object = @object_handler.update(@id, attributes)
+        reinitialize(new_object)
+      else
+        raise ArgumentError.new("The update was unsuccesful.")
+      end
+      return self
+    end
+
+    def delete
+      raise ArgumentError.new("No object_handler is attached to this object") unless @object_handler
+      @object_handler.delete(@id)
+    end
+
+    def to_s
+      "<Plate #{self.class.name.split('::').last}, @id=#{@id}, @attributes=#{@attributes}, @object_handler=#{@object_handler}>"
+    end
+
+    def inspect
+      to_s
+    end
+
+    def method_missing(m, *args, &block)
+      if attributes[m.to_s]
+        return attributes[m.to_s]
+      elsif attributes["content"] && attributes["content"][m.to_s]
+        return attributes["content"][m.to_s]["value"]
+      else
+        super
+      end
+    end
+
+    def ==(other)
+      return other.id == @id && other.class == self.class
+    end
+
+    private
+
+    def reinitialize(new_object)
+      initialize_state(new_object.attributes, new_object.relations)
+    end
+
+    def initialize_state(attributes, relations)
+      set_relation_ids(relations)
+      @attributes = attributes
+      @relations = relations
+    end
+
+    def self.has_one(name, klass)
+      self.attr_accessor "#{name}_id"
+      HasOneRelations[name.to_s] = klass
+      define_has_one_method(name, klass)
+    end
+
+    def self.define_has_one_method(name, klass)
+      define_method(name.to_s) do
+        id = self.send("#{name}_id")
+        return nil unless id
+        @object_handler.api_connector.handler(Object.const_get(klass)).find(id)
+      end
+    end
+
+    def self.has_many(plural_name, singular_name, klass, define_create_method=false)
+      HasManyRelations[plural_name.to_s] = klass
+      define_has_many_method(plural_name, klass)
+      define_create_method(singular_name, klass) if define_create_method
+    end
+
+    def self.define_has_many_method(plural_name, klass)
+      define_method(plural_name.to_s) do
+        @object_handler.api_connector.handler(Object.const_get(klass)).index(self.class, @id)
+      end
+    end
+
+    def self.define_create_method(singular_name, klass)
+      define_method("create_#{singular_name}") do |create_attributes|
+        @object_handler.api_connector.handler(Object.const_get(klass)).create(self, create_attributes)
+      end
+    end
+
+    def set_relation_ids(relations_attributes)
+      return unless relations_attributes
+      self.class::HasOneRelations.keys.each do |relation_name|
+        val = relations_attributes["#{relation_name}_id"]
+        if val
+          send("#{relation_name}_id=", val)
+        end
+      end
+    end
+  end
+end

data/lib/plate_api/plate_object/column.rb

@@ -0,0 +1,15 @@
+module PlateApi::PlateObject
+  class Column < Base
+
+    has_one :row, "PlateApi::PlateObject::Row"
+    has_many :elements, :element, "PlateApi::PlateObject::Element", true
+
+    def self.api_name
+      "columns"
+    end
+
+    def self.parent_class
+      Row
+    end
+  end
+end

data/lib/plate_api/plate_object/company.rb

@@ -0,0 +1,15 @@
+module PlateApi::PlateObject
+  class Company < Base
+
+    has_one :partner, "PlateApi::PlateObject::Partner"
+    has_many :sites, :site, "PlateApi::PlateObject::Site"
+
+    def self.api_name
+      "companies"
+    end
+
+    def self.parent_class
+      Partner
+    end
+  end
+end

data/lib/plate_api/plate_object/element.rb

@@ -0,0 +1,14 @@
+module PlateApi::PlateObject
+  class Element < Base
+
+    has_one :column, "PlateApi::PlateObject::Column"
+
+    def self.api_name
+      "elements"
+    end
+
+    def self.parent_class
+      Column
+    end
+  end
+end

data/lib/plate_api/plate_object/partner.rb

@@ -0,0 +1,14 @@
+module PlateApi::PlateObject
+  class Partner < Base
+
+    has_many :companies, :company, "PlateApi::PlateObject::Company"
+
+    def self.api_name
+      "partners"
+    end
+
+    def self.parent_class
+      Partner
+    end
+  end
+end

data/lib/plate_api/plate_object/post.rb

@@ -0,0 +1,18 @@
+module PlateApi::PlateObject
+  class Post < Base
+
+    has_one :site_translation, "PlateApi::PlateObject::SiteTranslation"
+    has_many :sections, :section, "PlateApi::PlateObject::Section", true
+    has_many :rows, :row, "PlateApi::PlateObject::Row"
+    has_many :columns, :column, "PlateApi::PlateObject::Column"
+    has_many :elements, :element, "PlateApi::PlateObject::Element"
+
+    def self.api_name
+      "posts"
+    end
+
+    def self.parent_class
+      SiteTranslation
+    end
+  end
+end

data/lib/plate_api/plate_object/row.rb

@@ -0,0 +1,16 @@
+module PlateApi::PlateObject
+  class Row < Base
+
+    has_one :section, "PlateApi::PlateObject::Section"
+    has_many :columns, :column, "PlateApi::PlateObject::Column", true
+    has_many :elements, :element, "PlateApi::PlateObject::Element"
+
+    def self.api_name
+      "rows"
+    end
+
+    def self.parent_class
+      Section
+    end
+  end
+end

data/lib/plate_api/plate_object/section.rb

@@ -0,0 +1,17 @@
+module PlateApi::PlateObject
+  class Section < Base
+
+    has_one :post, "PlateApi::PlateObject::Post"
+    has_many :rows, :row, "PlateApi::PlateObject::Row", true
+    has_many :columns, :column, "PlateApi::PlateObject::Column"
+    has_many :elements, :element, "PlateApi::PlateObject::Element"
+
+    def self.api_name
+      "sections"
+    end
+
+    def self.parent_class
+      Post
+    end
+  end
+end

data/lib/plate_api/plate_object/site.rb

@@ -0,0 +1,28 @@
+module PlateApi::PlateObject
+  class Site < Base
+
+    has_one :theme, "PlateApi::PlateObject::Theme"
+    has_one :company, "PlateApi::PlateObject::Company"
+    has_many :site_translations, :site_translation, "PlateApi::PlateObject::SiteTranslation"
+    has_many :posts, :post, "PlateApi::PlateObject::Post"
+    has_many :sections, :section, "PlateApi::PlateObject::Section"
+    has_many :rows, :row, "PlateApi::PlateObject::Row"
+    has_many :columns, :column, "PlateApi::PlateObject::Column"
+    has_many :elements, :element, "PlateApi::PlateObject::Element"
+    has_many :attachments, :attachment, "PlateApi::PlateObject::Attachment"
+
+    def self.api_name
+      "sites"
+    end
+
+    def self.parent_class
+      Company
+    end
+
+    def create_attachment(file, extra_parameters={})
+      raise ArgumentError.new("No File is given as input") unless file.is_a? File
+      parameters = extra_parameters.merge({file: file})
+      @object_handler.api_connector.handler(PlateApi::PlateObject::Attachment).create(self, parameters, :post_multipart)
+    end
+  end
+end

data/lib/plate_api/plate_object/site_translations.rb

@@ -0,0 +1,19 @@
+module PlateApi::PlateObject
+  class SiteTranslation < Base
+
+    has_one :site, "PlateApi::PlateObject::Site"
+    has_many :posts, :post, "PlateApi::PlateObject::Post", true
+    has_many :sections, :section, "PlateApi::PlateObject::Section"
+    has_many :rows, :row, "PlateApi::PlateObject::Row"
+    has_many :columns, :column, "PlateApi::PlateObject::Column"
+    has_many :elements, :element, "PlateApi::PlateObject::Element"
+
+    def self.api_name
+      "site_translations"
+    end
+
+    def self.parent_class
+      Site
+    end
+  end
+end

data/lib/plate_api/plate_object/theme.rb

@@ -0,0 +1,8 @@
+module PlateApi::PlateObject
+  class Theme < Base
+
+    def self.api_name
+      "themes"
+    end
+  end
+end

data/lib/plate_api/post_multipart_request.rb

@@ -0,0 +1,35 @@
+require 'mimemagic'
+
+module PlateApi
+  class PostMultipartRequest < Request
+    HttpAdapter = :net_http
+
+    def initialize(public_key, secret, path, parameters={}, custom_server=nil)
+      super(public_key, secret, "POST", path, custom_server)
+
+      @post_parameters = map_parameters(parameters)
+    end
+
+    def extra_builder_options(builder)
+      builder.request :multipart
+	    builder.request :url_encoded
+    end
+
+    def extra_request_options(request)
+      request.body = @post_parameters
+    end
+
+    def map_parameters(parameters)
+      parameters.keys.each do |key|
+        val = parameters[key]
+        if val.is_a? File
+          full_path = File.expand_path(val)
+          mime_type = MimeMagic.by_path(full_path).type
+          parameters[key] = Faraday::UploadIO.new(full_path, mime_type)
+        end
+      end
+
+      return parameters
+    end
+  end
+end

data/lib/plate_api/put_request.rb

@@ -1,5 +1,3 @@
-require "plate_api/request"
-
 module PlateApi
   class PutRequest < Request
 

data/lib/plate_api/request.rb

@@ -3,18 +3,20 @@ require 'faraday_middleware'
 require 'time'
 require "base64"
 require "openssl"
+require "json"
 
 
 module PlateApi
   class Request
     DefaultApiBaseEndpoint = "https://www.startwithplate.com/api/v2"
+    HttpAdapter = Faraday.default_adapter
 
     def initialize(public_key, secret, method, path, custom_server=nil)
       base_api_endpoint = custom_server ? custom_server : DefaultApiBaseEndpoint
 
       @connection = ::Faraday.new(url: base_api_endpoint) do |faraday|
-        faraday.response    :json
-        faraday.adapter     Faraday.default_adapter
+        extra_builder_options(faraday)
+        faraday.adapter     HttpAdapter
       end
 
       @public_key = public_key
@@ -23,16 +25,20 @@ module PlateApi
       @path = strip_path(path)
     end
 
-    def send
+    def execute(response_type=:raw)
       response = @connection.send(@method.downcase) do |request|
         request.url url_path
         request.headers['Date'] = request_date
         request.headers['Authorization'] = calculate_signature
-        request.headers['Content-Type'] = 'application/json'
         extra_request_options(request)
       end
 
-      return response.body
+      return case response_type
+      when :raw
+        return response.body
+      when :json
+        return JSON.parse(response.body)
+      end
     end
 
     def request_date
@@ -62,6 +68,9 @@ module PlateApi
     def extra_request_options(request)
     end
 
+    def extra_builder_options(request)
+    end
+
     def strip_path(path)
       path.gsub(/^\/|\/$/, '')
     end

data/lib/plate_api/version.rb

@@ -1,3 +1,3 @@
 module PlateApi
-  VERSION = "0.4.0"
+  VERSION = "1.0.0"
 end

data/lib/plate_api.rb

@@ -1,5 +1,15 @@
 require "plate_api/version"
+require "plate_api/object_handler"
+require "plate_api/plate_object/base"
+Dir[File.join(__dir__,"plate_api/plate_object/", "*.rb")].each {|file| require file }
 require "plate_api/connector"
+require "plate_api/request"
+require "plate_api/get_request"
+require "plate_api/delete_request"
+require "plate_api/post_request"
+require "plate_api/post_multipart_request"
+require "plate_api/put_request"
+
 
 module PlateApi
 end

data/plate_api.gemspec

@@ -9,7 +9,8 @@ Gem::Specification.new do |spec|
   spec.date        = '2019-01-05'
   spec.summary     = "Connector for the Plate API"
   spec.description = "This gem can be used to connect to the Plate API. It takes care
-  of the authentication procedure. "
+  of the authentication procedure. It also provides a basic wrapper around the Plate API,
+  so objects in Plate can be manipulated as local objects."
   spec.authors     = ["David Kortleven"]
   spec.email       = 'david@getplate.com'
   spec.files       = ["lib/plate_api.rb"]
@@ -33,8 +34,15 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "faraday", "~> 0.15.4"
   spec.add_dependency "faraday_middleware", "~> 0.13.1"
+  spec.add_dependency "mimemagic", "~> 0.3.3"
 
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock", "~> 3.0"
+  spec.add_development_dependency "factory_bot", "~> 5.0.1"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "simplecov-console"
+  spec.add_development_dependency "byebug"
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: plate_api
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 1.0.0
 platform: ruby
 authors:
 - David Kortleven
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.13.1
+- !ruby/object:Gem::Dependency
+  name: mimemagic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.3
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -80,13 +94,86 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: "This gem can be used to connect to the Plate API. It takes care\n  of
-  the authentication procedure. "
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.1
+- !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: simplecov-console
+  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: byebug
+  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: |-
+  This gem can be used to connect to the Plate API. It takes care
+    of the authentication procedure. It also provides a basic wrapper around the Plate API,
+    so objects in Plate can be manipulated as local objects.
 email: david@getplate.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".byebug_history"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -101,6 +188,20 @@ files:
 - lib/plate_api/connector.rb
 - lib/plate_api/delete_request.rb
 - lib/plate_api/get_request.rb
+- lib/plate_api/object_handler.rb
+- lib/plate_api/plate_object/attachment.rb
+- lib/plate_api/plate_object/base.rb
+- lib/plate_api/plate_object/column.rb
+- lib/plate_api/plate_object/company.rb
+- lib/plate_api/plate_object/element.rb
+- lib/plate_api/plate_object/partner.rb
+- lib/plate_api/plate_object/post.rb
+- lib/plate_api/plate_object/row.rb
+- lib/plate_api/plate_object/section.rb
+- lib/plate_api/plate_object/site.rb
+- lib/plate_api/plate_object/site_translations.rb
+- lib/plate_api/plate_object/theme.rb
+- lib/plate_api/post_multipart_request.rb
 - lib/plate_api/post_request.rb
 - lib/plate_api/put_request.rb
 - lib/plate_api/request.rb