nexboard-api 0.1.1 → 0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6af8f77bde99c40d78a90726c7102c576a1a443a
-  data.tar.gz: c29257410b533fca2dd9b3914193e62bd38e5c4b
+SHA256:
+  metadata.gz: 27ffd8587d8b3de5b0662d005ed7c13ad373fabb395ad00505b23b0572363782
+  data.tar.gz: 1bbf7e8db7a511f146b49b570e85c36adc8dec14900879041d56100b5cd3d386
 SHA512:
-  metadata.gz: 7843716a53bc009231487bda8c7df7e224d50a26fc481a56f8d7e55515cf23a33fc96cc159c2bfcb81238ada59a81a8701dd36c372ade72ba1440f0a9e8ec6f4
-  data.tar.gz: a2eb3768cd796e19d80663131158225ff2baa0dd1e708966f17edf80cde287362bfbe98532323744ca3f0298df5281075075ff693e40629f427af87bc757e498
+  metadata.gz: 5d97678d15db58085fce73c7d7c7a314e736622a6dc9d458835e24ec25fa90b84a679b6d390cab7a13454ac4fca7f0782a8ae24683b2c67c243b7a6cc858fe7b
+  data.tar.gz: 94ada08cecb3879d28bac06bea53c789730b5ea8262da6d4ab2e4ebc5e1bbed71b7a8f1424e7d7aef0a918717dab5847a8a7dc08abd9ec14118f4cd0c09769e1

data/lib/nexboard_api.rb

@@ -1,5 +1,9 @@
+# frozen_string_literal: true
+
+require 'restify'
+
 class NexboardApi
-  DEFAULT_BASE_URL = 'https://nexboard.nexenio.com/portal/api/public/'.freeze
+  DEFAULT_BASE_URL = 'https://nexboard.nexenio.com/portal/api/v1/public/'
 
   attr_reader :api_key, :user_id, :template_project_id, :base_url
 
@@ -11,52 +15,96 @@ class NexboardApi
                              DEFAULT_BASE_URL
                            else
                              base_url
-                           end    
+                           end
   end
-    
-  def get_project_ids
-    projects = Restify.new(@base_url + 'projects')
-                   .get(userId: @user_id, token: @api_key)
-                   .value!
 
-    projects.data.map{|project| project['project_id']}
+  def project_ids
+    projects = Restify.new(URI.join(base_url, 'projects'))
+      .get(userId: user_id, token: api_key)
+      .value!
+    projects.data.map(&:id)
   end
 
-  def create_project(title:, description:)
+  def create_project(title:, description: nil)
     data = {
-        title: title,
-        description: description,
-        user_id: @user_id
+      title: title,
+      userId: user_id,
     }
+    data[:description] = description if description
 
-    Restify.new(@base_url + 'projects')
-        .post(data, token: @api_key)
-        .value!
+    Restify.new(URI.join(base_url, 'projects'))
+      .post(data, token: api_key)
+      .value!
   end
 
-  def get_boards_for_project(project_id:)
-    Restify.new(@base_url + "projects/#{project_id}/boards")
-        .get(token: @api_key, userId: @user_id)
-        .value!
+  def boards_for_project(project_id:)
+    Restify.new(URI.join(base_url, "projects/#{project_id}/boards"))
+      .get(token: api_key, userId: user_id)
+      .value!
   end
 
-  def get_template_boards
-    return [] if @template_project_id.nil?
-    template_boards = get_boards_for_project(project_id: @template_project_id)
-    template_boards.data.map{ |board| {board_id: board['boardId'], title: board['title'] } }
+  def template_boards
+    return [] if template_project_id.nil?
+
+    template_boards = boards_for_project(project_id: template_project_id)
+    template_boards
+      .data
+      .map {|board| {board_id: board['id'], title: board['title']} }
   end
 
-  def create_board_for_project(project_id:, title:, description:, template_id: nil)
+  def create_board(project_id:, title:, description: nil, template_id: nil)
     data = {
-        project_id: project_id,
-        title: title,
-        description: description,
-        user_id: @user_id
+      projectId: project_id,
+      userId: user_id,
+      title: title,
     }
-    data.merge!(template_id: template_id) unless template_id.nil?
+    data[:description] = description if description
+    data[:template_id] = template_id unless template_id.nil?
+
+    Restify.new(URI.join(base_url, 'boards'))
+      .post(data, token: api_key)
+      .value!
+  end
+
+  def upload_image_to_board(board_id:, uploaded_io:)
+    uri = URI.join(
+      base_url,
+      "boards/images/#{board_id}",
+      "?token=#{api_key}",
+    )
+
+    multipart_request uri, uploaded_io
+  end
+
+  private
+
+  BOUNDARY = 'NexboardApiP3K'
+
+  def multipart_request(uri, uploaded_io)
+    uploaded_io.rewind
+
+    http = Net::HTTP.new uri.host, uri.port
+    request = Net::HTTP::Post.new uri.request_uri
+    request.body = post_body
+    request['Content-Type'] = "multipart/form-data, boundary=#{BOUNDARY}"
+
+    response = http.request(request)
+    response.is_a? Net::HTTPSuccess
+  end
+
+  def post_body(uploaded_io)
+    post_body = []
+    post_body << "--#{BOUNDARY}\r\n"
+    post_body << 'Content-Disposition: form-data; name="datafile"; '
+    post_body << "filename=\"#{to_ascii(uploaded_io.original_filename)}\"\r\n"
+    post_body << "Content-Type: text/plain\r\n"
+    post_body << "\r\n"
+    post_body << uploaded_io.tempfile.read
+    post_body << "\r\n--#{BOUNDARY}--\r\n"
+    post_body.join
+  end
 
-    Restify.new(@base_url + 'boards')
-        .post(data, token: @api_key)
-        .value!
+  def to_ascii(str)
+    str.encode('ascii', invalid: :replace, undef: :replace, replace: '?')
   end
-end
+end

data/nexboard-api.gemspec

@@ -1,18 +1,20 @@
+# frozen_string_literal: true
+
 Gem::Specification.new do |spec|
   spec.name          = 'nexboard-api'
-  spec.version       = '0.1.1'
+  spec.version       = '0.3'
   spec.authors       = ['Xikolo Development Team']
-  spec.email         = %w(xikolo-dev@hpi.uni-potsdam.de)
-  spec.description   = %q{Ruby wrapper for Nexboard API (https://nexboard.nexenio.com)}
-  spec.summary       = %q{Ruby wrapper for Nexboard API (https://nexboard.nexenio.com)}
+  spec.email         = %w[xikolo-dev@hpi.uni-potsdam.de]
+  spec.description   = 'Ruby wrapper for Nexboard API (https://nexboard.nexenio.com)'
+  spec.summary       = 'Ruby wrapper for Nexboard API (https://nexboard.nexenio.com)'
   spec.homepage      = 'https://github.com/openHPI/nexboard-api'
   spec.license       = ''
 
-  spec.files         = Dir['**/*'].grep(/((bin|lib|test|spec|features)\/|
-    .*\.gemspec|.*LICENSE.*|.*README.*|.*CHANGELOG.*)/x)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.files         = Dir['**/*'].grep(%r{((bin|lib|test|spec|features)/|
+    .*\.gemspec|.*LICENSE.*|.*README.*|.*CHANGELOG.*)}x)
+  spec.executables   = spec.files.grep(%r{^bin/}) {|f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = %w(lib)
+  spec.require_paths = %w[lib]
 
   spec.add_dependency 'restify'
 

data/spec/lib/nexboard_api_spec.rb

@@ -1,130 +1,203 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe NexboardApi do
+  subject(:api) { described_class.new(**params) }
+
   let(:api_key) { 'RandomApiKey' }
   let(:user_id) { 1337 }
-  let(:params)  { {api_key: api_key, user_id: user_id} }
-
-  let(:api)     { NexboardApi.new **params }
-
-  let(:default_base_url) { 'https://nexboard.nexenio.com/portal/api/public/' }
-  let(:default_headers)  { {'Content-Type' => 'application/json'} }
+  let(:params) { {api_key: api_key, user_id: user_id} }
+  let(:default_base_url) { 'https://nexboard.nexenio.com/portal/api/v1/public/' }
+  let(:default_headers) { {'Content-Type' => 'application/json'} }
 
   describe '#initialize' do
-    subject { NexboardApi.new **params }
-
-    it 'should be initialized with correct params' do
-      expect(subject.api_key).to eq(api_key)
-      expect(subject.user_id).to eq(user_id)
-      expect(subject.base_url).to eq(default_base_url)
+    it 'is initialized with correct params' do
+      expect(api.api_key).to eq(api_key)
+      expect(api.user_id).to eq(user_id)
+      expect(api.base_url).to eq(default_base_url)
     end
 
     context 'with custom base_url' do
       let(:params) { super().merge(base_url: 'https://p3k.com') }
 
-      it 'should be initialized with custom base_url' do
-        expect(subject.base_url).to eq('https://p3k.com')
-      end  
-    end  
+      it 'is initialized with custom base_url' do
+        expect(api.base_url).to eq('https://p3k.com')
+      end
+    end
 
     context 'with template_project_id' do
       let(:params) { super().merge(template_project_id: 666) }
 
-      it 'should be initialized with template_project_id' do
-        expect(subject.template_project_id).to eq(666)
-      end  
-    end 
+      it 'is initialized with template_project_id' do
+        expect(api.template_project_id).to eq(666)
+      end
+    end
   end
 
-  describe '#get_project_ids' do
-    subject { api.get_project_ids }
+  describe '#project_ids' do
+    subject(:project_ids) { api.project_ids }
 
     let!(:projects_stub) do
-      stub_request(:get, "#{default_base_url}projects?token=#{api_key}&userId=#{user_id}").
-         with(headers: default_headers).
-         to_return(status: 200, body: "[{\"project_id\": 1}, {\"project_id\": 3000}]", headers: default_headers)
-    end  
+      stub_request(:get, "#{default_base_url}projects?token=#{api_key}&userId=#{user_id}")
+        .with(headers: default_headers)
+        .to_return(status: 200, body: '[{"id": 1}, {"id": 3000}]', headers: default_headers)
+    end
 
-    it 'should request Nexboard API' do
-      subject
+    it 'requests Nexboard API' do
+      project_ids
       expect(projects_stub).to have_been_requested
-    end 
+    end
 
-    it 'should return a list of project ids' do
-      expect(subject).to eq([1, 3000])
-    end  
+    it 'returns a list of project ids' do
+      expect(project_ids).to eq([1, 3000])
+    end
   end
 
   describe '#create_project' do
+    subject(:create_project) { api.create_project(**create_params) }
+
     let(:create_params) { {title: 'My project', description: 'My description'} }
 
-    subject { api.create_project **create_params }
+    let(:create_body) do
+      {
+        userId: user_id,
+        title: 'My project',
+        description: 'My description',
+      }
+    end
 
     let!(:create_project_stub) do
-      stub_request(:post, "#{default_base_url}projects?token=#{api_key}").
-         with(headers: default_headers, body: create_params.merge(user_id: user_id)).
-         to_return(status: 200, body: "{}", headers: default_headers)
+      stub_request(:post, "#{default_base_url}projects?token=#{api_key}")
+        .with(
+          headers: default_headers,
+          body: create_body,
+        )
+        .to_return(status: 200, body: '{}', headers: default_headers)
     end
 
-    it 'should request Nexboard API' do
-      subject
+    it 'requests Nexboard API' do
+      create_project
       expect(create_project_stub).to have_been_requested
-    end 
+    end
+
+    context 'without description' do
+      let(:create_params) { {title: 'My project'} }
+
+      let(:create_body) do
+        {
+          userId: user_id,
+          title: 'My project',
+        }
+      end
+
+      it 'requests Nexboard API' do
+        create_project
+        expect(create_project_stub).to have_been_requested
+      end
+    end
   end
 
-  describe '#get_boards_for_project' do
-    let(:project_id) { 123 }
+  describe '#boards_for_project' do
+    subject(:boards) { api.boards_for_project project_id: project_id }
 
-    subject { api.get_boards_for_project project_id: project_id }
+    let(:project_id) { 123 }
 
     let(:board) do
       {
-        boardId: 1,
-        project_id: project_id,
+        id: 1,
+        projectId: project_id,
         title: 'My board',
-        description: 'My description'
+        description: 'My description',
       }
-    end  
+    end
 
     let!(:boards_stub) do
-      stub_request(:get, "#{default_base_url}projects/#{project_id}/boards?token=#{api_key}&userId=#{user_id}").
-         with(headers: default_headers).
-         to_return(status: 200, body: "[#{board.to_json}]", headers: default_headers)
+      stub_request(:get, "#{default_base_url}projects/#{project_id}/boards?token=#{api_key}&userId=#{user_id}")
+        .with(headers: default_headers)
+        .to_return(status: 200, body: "[#{board.to_json}]", headers: default_headers)
     end
 
-    it 'should request Nexboard API' do
-      subject
+    it 'requests Nexboard API' do
+      boards
       expect(boards_stub).to have_been_requested
     end
 
-    it 'should return a list of board resources' do
-      expect(subject.data.to_json).to eq([board].to_json)
-    end 
+    it 'returns a list of board resources' do
+      expect(boards.data.to_json).to eq([board].to_json)
+    end
+
+    context 'without description' do
+      let(:board) do
+        {
+          id: 1,
+          projectId: project_id,
+          title: 'My board',
+        }
+      end
+
+      it 'requests Nexboard API' do
+        boards
+        expect(boards_stub).to have_been_requested
+      end
+    end
   end
 
-  describe '#create_board_for_project' do
-    let(:create_params) { {project_id: 123, title: 'My title', description: 'My description'} }
+  describe '#create_board' do
+    subject(:create_board) { api.create_board(**create_params) }
 
-    subject { api.create_board_for_project **create_params }
+    let(:create_params) do
+      {
+        project_id: 123,
+        title: 'My title',
+        description: 'My description',
+      }
+    end
+
+    let(:create_body) do
+      {
+        projectId: 123,
+        title: 'My title',
+        description: 'My description',
+        userId: user_id,
+      }
+    end
 
     let(:create_board_stub) do
-      stub_request(:post, "#{default_base_url}boards?token=#{api_key}").
-         with(headers: default_headers, body: create_params.merge(user_id: user_id)).
-         to_return(status: 200, body: "{}", headers: default_headers)
+      stub_request(:post, "#{default_base_url}boards?token=#{api_key}")
+        .with(headers: default_headers, body: create_body)
+        .to_return(status: 200, body: '{}', headers: default_headers)
     end
 
-    before { create_board_stub; subject }
+    before { create_board_stub; create_board }
 
-    it 'should request Nexboard API' do
+    it 'requests Nexboard API' do
       expect(create_board_stub).to have_been_requested
-    end 
+    end
 
     context 'with template_id' do
-      let(:create_params) { super().merge(template_id: 1234) }
-
-      it 'should request Nexboard API' do
+      let(:create_params) do
+        {
+          project_id: 123,
+          title: 'My title',
+          description: 'My description',
+          template_id: 1234,
+        }
+      end
+
+      let(:create_body) do
+        {
+          projectId: 123,
+          title: 'My title',
+          description: 'My description',
+          userId: user_id,
+          template_id: 1234,
+        }
+      end
+
+      it 'requests Nexboard API' do
         expect(create_board_stub).to have_been_requested
-      end 
-    end  
+      end
+    end
   end
 end

data/spec/pact_helper.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'pact/consumer/rspec'
+require 'restify'
+require 'nexboard_api'
+
+Pact.service_consumer 'OpenHPI' do
+  has_pact_with 'nexboard' do
+    mock_service :nexboard do
+      port 1234
+    end
+  end
+end

data/spec/pacts/nexboard_api_pact_spec.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+require 'pact_helper'
+
+describe NexboardApi, pact: true do
+  let(:api_key) { 'RandomApiKey' }
+  let(:user_id) { '1337' }
+  let(:base_url) { 'http://localhost:1234/' }
+  let(:params) { {api_key: api_key, user_id: user_id, base_url: base_url} }
+  let(:encoded_credentials) { CGI.escape("token=#{api_key}&userId=#{user_id}") }
+  let(:encoded_token) { CGI.escape("token=#{api_key}") }
+  let(:client) { described_class.new(**params) }
+
+  describe 'get_project_ids' do
+    let(:response) { [{project_id: '1'}, {project_id: '2'}] }
+
+    before do
+      nexboard.given('user has valid credentials and some projects exist')
+        .upon_receiving('a request to get all projects')
+        .with(method: :get, path: '/projects', query: encoded_credentials)
+        .will_respond_with(
+          status: 200,
+          headers: {'Content-Type' => 'application/json'},
+          body: response,
+        )
+    end
+
+    it 'returns the project ids' do
+      project_ids = client.get_project_ids
+      expect(project_ids).to eq(%w[1 2])
+    end
+  end
+
+  describe 'create_project' do
+    let(:title) { 'A new project' }
+    let(:description) { 'This is a new project' }
+    let(:project_id) { '1' }
+    let(:response) { {project_id: project_id, title: title} }
+    let(:project_data) { {title: title, description: description} }
+    let(:post_body) { {title: title, description: description, user_id: user_id} }
+
+    before do
+      nexboard.given('user has valid credentials')
+        .upon_receiving('a request to create a project')
+        .with(method: :post, path: '/projects', query: encoded_token, body: post_body)
+        .will_respond_with(
+          status: 200,
+          headers: {'Content-Type' => 'application/json'},
+          body: response,
+        )
+    end
+
+    it 'returns a new project' do
+      project = client.create_project(project_data)
+      expect(project.project_id).to eq(project_id)
+    end
+  end
+
+  describe 'get_boards_for_project' do
+    let(:title) { 'A board' }
+    let(:project_id) { '1' }
+    let(:board_id) { '101' }
+    let(:response) { [{boardId: board_id, title: title}] }
+
+    before do
+      nexboard.given('user has valid credentials and an existing project with boards')
+        .upon_receiving('a request to get boards of a project')
+        .with(method: :get, path: "/projects/#{project_id}/boards", query: encoded_credentials)
+        .will_respond_with(
+          status: 200,
+          headers: {'Content-Type' => 'application/json'},
+          body: response,
+        )
+    end
+
+    it 'returns a new project' do
+      boards = client.get_boards_for_project(project_id: project_id)
+      expect(boards.first.boardId).to eq(board_id)
+    end
+  end
+
+  describe 'create_board_for_project' do
+    let(:title) { 'A new project' }
+    let(:description) { 'This is a new project' }
+    let(:project_id) { '1' }
+    let(:board_id) { '101' }
+    let(:response) { {board_id: board_id, project_id: project_id, title: title} }
+    let(:board_data) { {title: title, description: description, project_id: project_id} }
+    let(:post_body) { {title: title, description: description, project_id: project_id, user_id: user_id} }
+
+    before do
+      nexboard.given('user has valid credentials and an existing project')
+        .upon_receiving('a request to create a project')
+        .with(method: :post, path: '/boards', query: encoded_token, body: post_body)
+        .will_respond_with(
+          status: 200,
+          headers: {'Content-Type' => 'application/json'},
+          body: response,
+        )
+    end
+
+    it 'returns a new project' do
+      board = client.create_board_for_project(board_data)
+      expect(board.board_id).to eq(board_id)
+    end
+  end
+end

data/spec/pacts/openhpi-nexboard.json

@@ -0,0 +1,109 @@
+{
+  "consumer": {
+    "name": "OpenHPI"
+  },
+  "provider": {
+    "name": "nexboard"
+  },
+  "interactions": [
+    {
+      "description": "a request to get all projects",
+      "providerState": "user has valid credentials and some projects exist",
+      "request": {
+        "method": "get",
+        "path": "/projects",
+        "query": "token=RandomApiKey&userId=1337"
+      },
+      "response": {
+        "status": 200,
+        "headers": {
+          "Content-Type": "application/json"
+        },
+        "body": [
+          {
+            "project_id": "1"
+          },
+          {
+            "project_id": "2"
+          }
+        ]
+      }
+    },
+    {
+      "description": "a request to create a project",
+      "providerState": "user has valid credentials",
+      "request": {
+        "method": "post",
+        "path": "/projects",
+        "query": "token=RandomApiKey",
+        "body": {
+          "title": "A new project",
+          "description": "This is a new project",
+          "user_id": "1337"
+        }
+      },
+      "response": {
+        "status": 200,
+        "headers": {
+          "Content-Type": "application/json"
+        },
+        "body": {
+          "project_id": "1",
+          "title": "A new project"
+        }
+      }
+    },
+    {
+      "description": "a request to get boards of a project",
+      "providerState": "user has valid credentials and an existing project with boards",
+      "request": {
+        "method": "get",
+        "path": "/projects/1/boards",
+        "query": "token=RandomApiKey&userId=1337"
+      },
+      "response": {
+        "status": 200,
+        "headers": {
+          "Content-Type": "application/json"
+        },
+        "body": [
+          {
+            "boardId": "101",
+            "title": "A board"
+          }
+        ]
+      }
+    },
+    {
+      "description": "a request to create a project",
+      "providerState": "user has valid credentials and an existing project",
+      "request": {
+        "method": "post",
+        "path": "/boards",
+        "query": "token=RandomApiKey",
+        "body": {
+          "title": "A new project",
+          "description": "This is a new project",
+          "project_id": "1",
+          "user_id": "1337"
+        }
+      },
+      "response": {
+        "status": 200,
+        "headers": {
+          "Content-Type": "application/json"
+        },
+        "body": {
+          "board_id": "101",
+          "project_id": "1",
+          "title": "A new project"
+        }
+      }
+    }
+  ],
+  "metadata": {
+    "pactSpecification": {
+      "version": "2.0.0"
+    }
+  }
+}

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This file is copied to spec/ when you run 'rails generate rspec:install'
 require 'simplecov'
 SimpleCov.start do
@@ -14,7 +16,7 @@ require 'restify'
 
 # Requires supporting ruby files with custom matchers and macros, etc,
 # in spec/support/ and its subdirectories.
-Dir['spec/support/**/*.rb'].each {|f| require f}
+Dir['spec/support/**/*.rb'].each {|f| require f }
 
 RSpec.configure do |config|
   # ## Mock Framework

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nexboard-api
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: '0.3'
 platform: ruby
 authors:
 - Xikolo Development Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-04 00:00:00.000000000 Z
+date: 2019-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: restify
@@ -49,6 +49,9 @@ files:
 - lib/nexboard_api.rb
 - nexboard-api.gemspec
 - spec/lib/nexboard_api_spec.rb
+- spec/pact_helper.rb
+- spec/pacts/nexboard_api_pact_spec.rb
+- spec/pacts/openhpi-nexboard.json
 - spec/spec_helper.rb
 homepage: https://github.com/openHPI/nexboard-api
 licenses:
@@ -69,11 +72,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Ruby wrapper for Nexboard API (https://nexboard.nexenio.com)
 test_files:
 - spec/lib/nexboard_api_spec.rb
+- spec/pact_helper.rb
+- spec/pacts/nexboard_api_pact_spec.rb
+- spec/pacts/openhpi-nexboard.json
 - spec/spec_helper.rb