ruby-trello-czuger 2.0.0

data/spec/oauth_policy_spec.rb

@@ -0,0 +1,160 @@
+require 'spec_helper'
+
+include Trello
+include Trello::Authorization
+
+describe OAuthPolicy do
+  before do
+    OAuthPolicy.consumer_credential = OAuthCredential.new 'xxx', 'xxx'
+    OAuthPolicy.token = nil
+  end
+
+  describe '#consumer_credential' do
+    it 'uses class setting if available' do
+      policy = OAuthPolicy.new
+      expect(policy.consumer_credential.key).to eq('xxx')
+      expect(policy.consumer_credential.secret).to eq('xxx')
+    end
+
+    it 'is built from given consumer_key and consumer_secret' do
+      policy = OAuthPolicy.new(
+        consumer_key: 'consumer_key',
+        consumer_secret: 'consumer_secret'
+      )
+      expect(policy.consumer_credential.key).to eq('consumer_key')
+      expect(policy.consumer_credential.secret).to eq('consumer_secret')
+    end
+
+    it 'is nil if none supplied to class' do
+      OAuthPolicy.consumer_credential = nil
+      policy = OAuthPolicy.new
+      expect(policy.consumer_credential).to be_nil
+    end
+  end
+
+  describe '#token' do
+    it 'uses class setting if available' do
+      OAuthPolicy.token = OAuthCredential.new 'xxx', 'xxx'
+      policy = OAuthPolicy.new
+      expect(policy.token.key).to eq('xxx')
+      expect(policy.token.secret).to eq('xxx')
+    end
+
+    it 'is built from given oauth_token and oauth_token_secret' do
+      policy = OAuthPolicy.new(
+        oauth_token: 'oauth_token',
+        oauth_token_secret: 'oauth_token_secret'
+      )
+      expect(policy.token.key).to eq('oauth_token')
+      expect(policy.token.secret).to eq('oauth_token_secret')
+    end
+
+    it 'is an empty token if no oauth credentials supplied' do
+      policy = OAuthPolicy.new
+      expect(policy.token).to be_nil
+    end
+  end
+
+  context '2-legged' do
+    it 'adds an authorization header' do
+      uri = Addressable::URI.parse('https://xxx/')
+
+      request = Request.new :get, uri
+
+      OAuthPolicy.token = OAuthCredential.new 'token', nil
+
+      authorized_request = OAuthPolicy.authorize request
+
+      expect(authorized_request.headers.keys).to include 'Authorization'
+    end
+
+    it 'preserves query parameters' do
+      uri = Addressable::URI.parse('https://xxx/?name=Riccardo')
+      request = Request.new :get, uri
+
+      allow(Clock)
+        .to receive(:timestamp)
+        .and_return '1327048592'
+
+      allow(Nonce)
+        .to receive(:next)
+        .and_return 'b94ff2bf7f0a5e87a326064ae1dbb18f'
+
+      OAuthPolicy.consumer_credential = OAuthCredential.new 'consumer_key', 'consumer_secret'
+      OAuthPolicy.token               = OAuthCredential.new 'token', nil
+
+      authorized_request = OAuthPolicy.authorize request
+
+      the_query_parameters = Addressable::URI.parse(authorized_request.uri).query_values
+      expect(the_query_parameters).to eq({'name' => 'Riccardo'})
+    end
+
+    it 'adds the correct signature as part of authorization header' do
+      allow(Clock)
+        .to receive(:timestamp)
+        .and_return '1327048592'
+
+      allow(Nonce)
+        .to receive(:next)
+        .and_return 'b94ff2bf7f0a5e87a326064ae1dbb18f'
+
+      OAuthPolicy.consumer_credential = OAuthCredential.new 'consumer_key', 'consumer_secret'
+      OAuthPolicy.token               = OAuthCredential.new 'token', nil
+
+      request = Request.new :get, Addressable::URI.parse('http://xxx/')
+
+      authorized_request = OAuthPolicy.authorize request
+
+      expect(authorized_request.headers['Authorization']).to match(/oauth_signature="TVNk%2FCs03FHqutDUqn05%2FDkvVek%3D"/)
+    end
+
+    it 'adds correct signature for uri with parameters' do
+      allow(Clock)
+        .to receive(:timestamp)
+        .and_return '1327351010'
+
+      allow(Nonce)
+        .to receive(:next)
+        .and_return 'f5474aaf44ca84df0b09870044f91c69'
+
+      OAuthPolicy.consumer_credential = OAuthCredential.new 'consumer_key', 'consumer_secret'
+      OAuthPolicy.token               = OAuthCredential.new 'token', nil
+
+      request = Request.new :get, Addressable::URI.parse('http://xxx/?a=b')
+
+      authorized_request = OAuthPolicy.authorize request
+
+      expect(authorized_request.headers['Authorization']).to match(/oauth_signature="DprU1bdbNdJQ40UhD4n7wRR9jts%3D"/)
+    end
+
+    it 'fails if consumer_credential is unset' do
+      OAuthPolicy.consumer_credential = nil
+
+      request = Request.new :get, Addressable::URI.parse('http://xxx/')
+
+      expect { OAuthPolicy.authorize request }.to raise_error 'The consumer_credential has not been supplied.'
+    end
+
+    it 'can sign with token' do
+      allow(Clock)
+        .to receive(:timestamp)
+        .and_return '1327360530'
+
+      allow(Nonce)
+        .to receive(:next)
+        .and_return '4f610cb28e7aa8711558de5234af1f0e'
+
+      OAuthPolicy.consumer_credential = OAuthCredential.new 'consumer_key', 'consumer_secret'
+      OAuthPolicy.token  = OAuthCredential.new 'token_key', 'token_secret'
+
+      request = Request.new :get, Addressable::URI.parse('http://xxx/')
+
+      authorized_request = OAuthPolicy.authorize request
+
+      expect(authorized_request.headers['Authorization']).to match(/oauth_signature="1Boj4fo6KiXA4xGD%2BKF5QOD36PI%3D"/)
+    end
+
+    it 'adds correct signature for https uri'
+    it 'adds correct signature for verbs other than get'
+  end
+end

data/spec/organization_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+module Trello
+  describe Organization do
+    include Helpers
+
+    let(:organization) { client.find(:organization, '4ee7e59ae582acdec8000291') }
+    let(:client) { Client.new }
+
+    before do
+      allow(client)
+        .to receive(:get)
+        .with('/organizations/4ee7e59ae582acdec8000291', {})
+        .and_return organization_payload
+    end
+
+    context 'finding' do
+      let(:client) { Trello.client }
+
+      it 'delegates to Trello.client#find' do
+        expect(client)
+          .to receive(:find)
+          .with(:organization, '4ee7e59ae582acdec8000291', {})
+
+        Organization.find('4ee7e59ae582acdec8000291')
+      end
+
+      it 'is equivalent to client#find' do
+        expect(Organization.find('4ee7e59ae582acdec8000291')).to eq(organization)
+      end
+    end
+
+    context 'actions' do
+      it 'retrieves actions' do
+        allow(client)
+          .to receive(:get)
+          .with('/organizations/4ee7e59ae582acdec8000291/actions', { filter: :all })
+          .and_return actions_payload
+
+        expect(organization.actions.count).to be > 0
+      end
+    end
+
+    describe "#update_fields" do
+      it "does not set any fields when the fields argument is empty" do
+        expected = {
+          'id' => 'id',
+          'name' => 'name',
+          'displayName' => 'display_name',
+          'desc' => 'description',
+          'url' => 'url',
+          'invited' => 'invited',
+          'website' => 'website',
+          'logoHash' => 'logo_hash',
+          'billableMemberCount' => 'billable_member_count',
+          'activeBillableMemberCount' => 'active_billable_member_count',
+          'memberships' => 'memberships'
+        }
+
+        organization = Organization.new(expected)
+
+        organization.update_fields({})
+
+        expected.each do |key, value|
+          expect(organization.send(value)).to eq expected[key]
+        end
+      end
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,435 @@
+require 'rubygems'
+
+unless defined? Rubinius
+  require 'simplecov'
+  SimpleCov.start
+end
+
+begin
+  require 'pry-byebug'
+rescue LoadError
+end
+
+# Set up gems listed in the Gemfile.
+begin
+  ENV['BUNDLE_GEMFILE'] = File.expand_path('../Gemfile', File.dirname(__FILE__))
+  require 'bundler'
+  Bundler.setup
+rescue Bundler::GemNotFound => e
+  STDERR.puts e.message
+  STDERR.puts 'Try running `bundle install`.'
+  exit!
+end
+
+Bundler.require(:spec)
+
+require 'trello'
+require 'webmock/rspec'
+require 'stringio'
+
+Trello.logger = Logger.new(StringIO.new)
+
+RSpec.configure do |rspec|
+  rspec.filter_run_excluding broken: true
+
+  rspec.before :each do
+    Trello.reset!
+  end
+
+  rspec.around(:each, :silence_warnings) do |example|
+    verbose = $VERBOSE
+    $VERBOSE = nil
+    example.run
+    $VERBOSE = verbose
+  end
+end
+
+module Helpers
+  def user_details
+    {
+      'id'         => 'abcdef123456789012345678',
+      'fullName'   => 'Test User',
+      'username'   => 'me',
+      'intials'    => 'TU',
+      'avatarHash' => 'abcdef1234567890abcdef1234567890',
+      'bio'        => 'a rather dumb user',
+      'url'        => 'https://trello.com/me',
+      'email'      => 'johnsmith@example.com'
+    }
+  end
+
+  def user_payload
+    JSON.generate(user_details)
+  end
+
+  def boards_details
+    [{
+      'id'               => 'abcdef123456789123456789',
+      'name'             => 'Test',
+      'desc'             => 'This is a test board',
+      'closed'           => false,
+      'starred'          => false,
+      'idOrganization'   => 'abcdef123456789123456789',
+      'url'              => 'https://trello.com/board/test/abcdef123456789123456789',
+      'dateLastActivity' => '2012-12-08T18:40:24.314Z'
+    },
+    {
+      name:            'Test',
+      desc:            'This is a test board',
+      closed:          false,
+      starred:         false,
+      organization_id: 'abcdef123456789123456789'
+    }]
+  end
+
+  def boards_payload
+    JSON.generate(boards_details)
+  end
+
+  def checklists_details
+    [{
+      'id'         => 'abcdef123456789123456789',
+      'name'       => 'Test Checklist',
+      'desc'       => 'A marvelous little checklist',
+      'closed'     => false,
+      'pos'        => 16384,
+      'url'        => 'https://trello.com/blah/blah',
+      'idBoard'    => 'abcdef123456789123456789',
+      'idCard'     => 'abccardid',
+      'idList'     => 'abcdef123456789123456789',
+      'idMembers'  => ['abcdef123456789123456789'],
+      'checkItems' => { 'id' => 'ghijk987654321' }
+    },
+    {
+      name:    'A marvelous little checklist',
+      card_id: 'abccardid'
+    }]
+  end
+
+  def checklists_payload
+    JSON.generate(checklists_details)
+  end
+
+  def copied_checklists_details
+    [{
+      'id'         => 'uvwxyz987654321987654321',
+      'name'       => 'Test Checklist',
+      'desc'       => '',
+      'closed'     => nil,
+      'position'   => 99999,
+      'url'        => nil,
+      'idBoard'    => 'abcdef123456789123456789',
+      'idList'     => nil,
+      'idMembers'  => nil,
+      'checkItems' => []
+    }]
+  end
+
+  def copied_checklists_payload
+    JSON.generate(copied_checklists_details)
+  end
+
+  def lists_details
+    [{
+      'id'           => 'abcdef123456789123456789',
+      'name'         => 'To Do',
+      'closed'       => false,
+      'idBoard'      => 'abcdef123456789123456789',
+      'idListSource' => 'abcdef123456789123456780',
+      'cards'        => cards_details,
+      'pos'          => 12
+    },
+    {
+      name:           'To Do',
+      board_id:       'abcdef123456789123456789',
+      pos:            12,
+      source_list_id: 'abcdef123456789123456780'
+    }
+    ]
+  end
+
+  def lists_payload
+    JSON.generate(lists_details)
+  end
+
+  def cards_details
+    [{
+      'id'                => 'abcdef123456789123456789',
+      'idShort'           => '1',
+      'name'              => 'Do something awesome',
+      'desc'              => 'Awesome things are awesome.',
+      'closed'            => false,
+      'idList'            => 'abcdef123456789123456789',
+      'idBoard'           => 'abcdef123456789123456789',
+      'idAttachmentCover' => 'abcdef123456789123456789',
+      'idMembers'         => ['abcdef123456789123456789'],
+      'labels'            => label_details,
+      'idLabels'          => [ 'abcdef123456789123456789',
+                               'bbcdef123456789123456789',
+                               'cbcdef123456789123456789',
+                               'dbcdef123456789123456789' ],
+      'url'               => 'https://trello.com/card/board/specify-the-type-and-scope-of-the-jit-in-a-lightweight-spec/abcdef123456789123456789/abcdef123456789123456789',
+      'shortUrl'          => 'https://trello.com/c/abcdef12',
+      'pos'               => 12,
+      'dateLastActivity'  => '2012-12-07T18:40:24.314Z'
+    },
+    {
+      name:                   'Do something awesome',
+      list_id:                'abcdef123456789123456789',
+      desc:                   'Awesome things are awesome.',
+      member_ids:             ['abcdef123456789123456789'],
+      card_labels:            [ 'abcdef123456789123456789',
+                              'bbcdef123456789123456789',
+                              'cbcdef123456789123456789',
+                              'dbcdef123456789123456789' ],
+      due:                    Date.today,
+      pos:                    12,
+      source_card_id:         'abcdef1234567891234567890',
+      source_card_properties: 'checklist,members'
+    }]
+  end
+
+
+  def cards_payload
+    JSON.generate(cards_details)
+  end
+
+  def attachments_details
+    [{
+       'id'           => 'abcdef123456789123456789',
+       'name'         => 'attachment1.png',
+       'url'          => 'http://trello-assets.domain.tld/attachment1.png',
+       'bytes'        => 98765,
+       'idMember'     => 'abcdef123456789123456781',
+       'isUpload'     => false,
+       'date'         => '2013-02-28T17:12:28.497Z',
+       'previews'     => 'previews'
+     },
+     {
+       'id'           => 'abcdef123456789123456781',
+       'name'         => 'attachment2.png',
+       'url'          => 'http://trello-assets.domain.tld/attachment2.png',
+       'bytes'        => 89123,
+       'idMember'     => 'abcdef123456789123456782',
+       'isUpload'     => true,
+       'date'         => '2013-03-01T14:01:25.212Z',
+     }]
+  end
+
+  def attachments_payload
+    JSON.generate(attachments_details)
+  end
+
+  def plugin_data_details
+    [
+      {
+        "id"=>"abcdef123456789123456779",
+        "idPlugin"=>"abcdef123456789123456879",
+        "scope"=>"card",
+        "idModel"=>"abcdef123456789123446879",
+        "value"=>"{\"fields\":{\"plugin_key\":\"plugin_value\"}}",
+        "access"=>"shared"
+      },
+      {
+        "id"=>"abcdef123456789123456879",
+        "idPlugin"=>"abcdef123456789123456779",
+        "scope"=>"card",
+        "idModel"=>"abcdef123456789123446579",
+        "value"=>"{\"fields\":{\"plugin_key\":\"plugin_value\"}}",
+        "access"=>"shared"
+      }
+    ]
+  end
+
+  def plugin_data_payload
+    JSON.generate(plugin_data_details)
+  end
+
+  def card_payload
+    JSON.generate(cards_details.first)
+  end
+
+  def orgs_details
+    [{
+      'id'          => 'abcdef123456789123456789',
+      'name'        => 'test',
+      'displayName' => 'Test Organization',
+      'desc'        => 'This is a test organization',
+      'url'         => 'https://trello.com/test'
+    }]
+  end
+
+  def orgs_payload
+    JSON.generate(orgs_details)
+  end
+
+  def actions_details
+    [{
+      'id'              => '4ee2482134a81a757a08af47',
+      'idMemberCreator' => 'abcdef123456789123456789',
+      'data' => {
+        'card'          => {
+          'id'          => '4ee2482134a81a757a08af45',
+          'name'        => 'Bytecode outputter'
+        },
+        'board'         => {
+          'id'          => '4ec54f2f73820a0dea0d1f0e',
+          'name'        => 'Caribou VM'
+        },
+        'list'          => {
+          'id'          => '4ee238b034a81a757a05cda0',
+          'name'        => 'Assembler'
+        }
+      },
+      'date'            => '2012-02-10T11:32:17Z',
+      'type'            => 'createCard'
+    }]
+  end
+
+  def actions_payload
+    JSON.generate(actions_details)
+  end
+
+  def notification_details
+    {
+      'id'              => '4f30d084d5b0f7ab453bee51',
+      'unread'          => false,
+      'type'            => 'commentCard',
+      'date'            => '2012-02-07T07:19:32.393Z',
+      'data'            => {
+        'board'         => {
+          'id'          => 'abcdef123456789123456789',
+          'name'        => 'Test'
+        },
+        'card' =>{
+          'id'          => 'abcdef123456789123456789',
+          'name'        => 'Do something awesome'
+        },
+        'text'          => 'test'
+      },
+      'idMemberCreator' => 'abcdef123456789012345678'
+    }
+  end
+
+  def notification_payload
+    JSON.generate(notification_details)
+  end
+
+  def organization_details
+    {
+        'id' => '4ee7e59ae582acdec8000291',
+        'name' => 'publicorg',
+        'desc' => 'This is a test organization',
+        'members' => [{
+            'id' => '4ee7df3ce582acdec80000b2',
+            'username' => 'alicetester',
+            'fullName' => 'Alice Tester'
+        }, {
+            'id' => '4ee7df74e582acdec80000b6',
+            'username' => 'davidtester',
+            'fullName' => 'David Tester'
+        }, {
+            'id' => '4ee7e2e1e582acdec8000112',
+            'username' => 'edtester',
+            'fullName' => 'Ed Tester'
+        }]
+    }
+  end
+
+  def organization_payload
+    JSON.generate(organization_details)
+  end
+
+  def token_details
+    {
+      'id'            => '4f2c10c7b3eb95a45b294cd5',
+      'idMember'      => 'abcdef123456789123456789',
+      'dateCreated'   => '2012-02-03T16:52:23.661Z',
+      'permissions'   => [
+        {
+          'idModel'   => 'me',
+          'modelType' => 'Member',
+          'read'      => true,
+          'write'     => true
+        },
+        {
+          'idModel'   => '*',
+          'modelType' => 'Board',
+          'read'      => true,
+          'write'     => true
+        },
+        {
+          'idModel'   => '*',
+          'modelType' => 'Organization',
+          'read'      => true,
+          'write'     => true
+        }
+      ]
+    }
+  end
+
+  def token_payload
+    JSON.generate(token_details)
+  end
+
+  def label_details
+    [
+      {'color' => 'yellow', 'name' => 'iOS', 'id' => 'abcdef123456789123456789', 'uses' => 3, 'idBoard' => 'abcdef123456789123456789'},
+      {'color' => 'purple', 'name' => 'Issue or bug', 'id' => 'bbcdef123456789123456789', 'uses' => 1, 'idBoard' => 'abcdef123456789123456789'},
+      {'color' => 'red', 'name' => 'deploy', 'id' => 'cbcdef123456789123456789', 'uses' => 2, 'idBoard' => 'abcdef123456789123456789'},
+      {'color' => 'blue', 'name' => 'on hold', 'id' => 'dbcdef123456789123456789', 'uses' => 6, 'idBoard' => 'abcdef123456789123456789'}
+    ]
+  end
+
+  def label_options
+    {
+      name:     'iOS',
+      board_id: 'abcdef123456789123456789',
+      color:    'yellow'
+    }
+  end
+
+  def label_payload
+    JSON.generate(label_details)
+  end
+
+  def webhooks_details
+    [
+     {
+       'id'          => 'webhookid',
+       'description' => 'Test webhook',
+       'idModel'     => '1234',
+       'callbackURL' => 'http://example.org/webhook',
+       'active'      => true
+     },
+     {
+       description:  'Test webhook',
+       id_model:     '1234',
+       cakkback_url: 'http://example.org/webhook'
+     }
+    ]
+  end
+
+  def label_name_details
+  [
+    {'yellow' => 'bug'},
+    {'red' => 'urgent'},
+    {'green' => 'deploy'},
+    {'blue' => 'on hold'},
+    {'orange' => 'new feature'},
+    {'purple' => 'experimental'}
+  ]
+  end
+
+  def label_name_payload
+    JSON.generate(label_name_details)
+  end
+
+  def webhooks_payload
+    JSON.generate(webhooks_details)
+  end
+
+  def webhook_payload
+    JSON.generate(webhooks_details.first)
+  end
+end