terminal.com 0.0.1 → 0.0.2

data/lib/terminal.com/api.rb

@@ -0,0 +1,202 @@
+require_relative '../terminal.com'
+
+module Terminal
+  class API
+    # https://www.terminal.com/faq#instanceTypes
+    INSTANCE_TYPES = {
+      micro:        {cpu: '2 (max)', ram: 256},
+      mini:         {cpu: 50,        ram: 800},
+      small:        {cpu: 100,       ram: 1600},
+      medium:       {cpu: 200,       ram: 3200},
+      xlarge:       {cpu: 400,       ram: 6400},
+      :'2xlarge' => {cpu: 800,       ram: 12_800},
+      :'4xlarge' => {cpu: 1600,      ram: 25_600},
+      :'8xlarge' => {cpu: 3200,      ram: 51_200}
+    }
+
+    def initialize(user_token, access_token)
+      @user_token, @access_token = user_token, access_token
+    end
+
+    ###############################
+    # CREATE AND MANAGE TERMINALS #
+    ###############################
+
+    def list_terminals
+      Terminal::API.list_terminals(@user_token, @access_token)
+    end
+
+    def get_terminal(**options)
+      Terminal::API.get_terminal(@user_token, @access_token, **options)
+    end
+
+    def start_snapshot(snapshot_id, **options)
+      if options[:instance]
+        unless instance_opts = INSTANCE_TYPES[options[:instance]]
+          raise ArgumentError.new("No such instance type: #{options[:instance].inspect}. Instance types are: #{INSTANCE_TYPES.keys.inspect[1..-2]}.")
+        end
+
+        options.delete(:instance)
+        options.merge!(instance_opts)
+      end
+
+      Terminal::API.start_snapshot(@user_token, @access_token, snapshot_id, **options)
+    end
+
+    def delete_terminal(container_key)
+      Terminal::API.delete_terminal(@user_token, @access_token, container_key)
+    end
+
+    def restart_terminal(container_key)
+      Terminal::API.restart_terminal(@user_token, @access_token, container_key)
+    end
+
+    def pause_terminal(container_key)
+      Terminal::API.pause_terminal(@user_token, @access_token, container_key)
+    end
+
+    def resume_terminal(container_key)
+      Terminal::API.resume_terminal(@user_token, @access_token, container_key)
+    end
+
+    def edit_terminal(container_key, **options)
+      Terminal::API.edit_terminal(@user_token, @access_token, container_key, **options)
+    end
+
+    ###############################
+    # CREATE AND MANAGE SNAPSHOTS #
+    ###############################
+
+    def list_snapshots(**options)
+      Terminal::API.list_snapshots(@user_token, @access_token, **options)
+    end
+
+    def count_snapshots(**options)
+      Terminal::API.count_snapshots(@user_token, @access_token, **options)
+    end
+
+    def delete_snapshot(snapshot_id)
+      Terminal::API.delete_snapshot(@user_token, @access_token, snapshot_id)
+    end
+
+    def edit_snapshot(snapshot_id, **options)
+      Terminal::API.edit_snapshot(@user_token, @access_token, snapshot_id, **options)
+    end
+
+    def snapshot_terminal(container_key, **options)
+      Terminal::API.snapshot_terminal(@user_token, @access_token, container_key, **options)
+    end
+
+    ##########################
+    # MANAGE TERMINAL ACCESS #
+    ##########################
+
+    def add_terminal_links(container_key, *links)
+      Terminal::API.add_terminal_links(@user_token, @access_token, container_key, *links)
+    end
+
+    def remove_terminal_links(container_key, *links)
+      Terminal::API.remove_terminal_links(@user_token, @access_token, container_key, *links)
+    end
+
+    def list_terminal_access(container_key)
+      Terminal::API.list_terminal_access(@user_token, @access_token, container_key)
+    end
+
+    def edit_terminal_access(container_key, **options)
+      Terminal::API.edit_terminal_access(@user_token, @access_token, container_key, **options)
+    end
+
+    #################################
+    # MANAGE TERMINAL DNS & DOMAINS #
+    #################################
+
+    def get_cname_records
+      Terminal::API.get_cname_records(@user_token, @access_token)
+    end
+
+    def add_domain_to_pool
+      Terminal::API.add_domain_to_pool(@user_token, @access_token, domain)
+    end
+
+    def remove_domain_from_pool
+      Terminal::API.remove_domain_from_pool(@user_token, @access_token, domain)
+    end
+
+    def add_cname_record(domain, subdomain, port)
+      Terminal::API.add_cname_record(@user_token, @access_token, domain, subdomain, port)
+    end
+
+    def remove_cname_record(domain)
+      Terminal::API.remove_cname_record(@user_token, @access_token, domain)
+    end
+
+    #################################
+    # MANAGE TERMINAL IDLE SETTINGS #
+    #################################
+
+    def set_terminal_idle_settings(container_key, action, *triggers)
+      Terminal::API.set_terminal_idle_settings(@user_token, @access_token, action, *triggers)
+    end
+
+    def get_terminal_idle_settings(container_key)
+      Terminal::API.get_terminal_idle_settings(@user_token, @access_token, container_key)
+    end
+
+    def balance
+      Terminal::API.balance(@user_token, @access_token)
+    end
+
+    def balance_added
+      Terminal::API.balance_added(@user_token, @access_token)
+    end
+
+    def gift(email, cents)
+      Terminal::API.gift(@user_token, @access_token, email, cents)
+    end
+
+    def burn_history
+      Terminal::API.burn_history(@user_token, @access_token)
+    end
+
+    def terminal_usage_history
+      Terminal::API.terminal_usage_history(@user_token, @access_token)
+    end
+
+    def burn_state
+      Terminal::API.burn_state(@user_token, @access_token)
+    end
+
+    def burn_estimates
+      Terminal::API.burn_estimates(@user_token, @access_token)
+    end
+
+    ##########################
+    # MANAGE SSH PUBLIC KEYS #
+    ##########################
+
+    def add_authorized_key_to_terminal(container_key, publicKey)
+      Terminal::API.add_authorized_key_to_terminal(@user_token, @access_token, container_key, publicKey)
+    end
+
+    def add_authorized_key_to_ssh_proxy(name, publicKey)
+      Terminal::API.add_authorized_key_to_ssh_proxy(@user_token, @access_token, name, publicKey)
+    end
+
+    def del_authorized_key_from_ssh_proxy(name, fingerprint)
+      Terminal::API.del_authorized_key_from_ssh_proxy(@user_token, @access_token, name, fingerprint)
+    end
+
+    def get_authorized_key_from_ssh_proxy
+      Terminal::API.get_authorized_key_from_ssh_proxy(@user_token, @access_token)
+    end
+
+    #########
+    # OTHER #
+    #########
+
+    def who_am_i
+      Terminal::API.who_am_i(@user_token, @access_token)
+    end
+  end
+end

data/spec/low-level/browse_snapshots_and_users_spec.rb

@@ -0,0 +1,158 @@
+describe Terminal do
+  describe '.get_snapshot(snapshot_id)' do
+    it 'fetches info about the snapshot' do
+      response = VCR.use_cassette('get_snapshot') do
+        described_class.get_snapshot(ubuntu_snap_id)
+      end
+
+      expect(response['snapshot']['title']).to eq('Official Ubuntu 14.04')
+      expect(response['snapshot']['author']).to eq('terminal')
+    end
+  end
+
+  describe '.get_profile(profile_id)' do
+    it 'fetches info about the profile' do
+      response = VCR.use_cassette('get_profile') do
+        described_class.get_profile('botanicus')
+      end
+
+      expect(response['user']['name']).to eq('James C Russell')
+      expect(response['user']['username']).to eq('botanicus')
+    end
+  end
+
+  describe '.list_public_snapshots(**options)' do
+    it 'fetches all the public snapshots by default' do
+      response = VCR.use_cassette('list_public_snapshots') do
+        described_class.list_public_snapshots
+      end
+
+      expect(response['snapshots'].length).to eq(460)
+    end
+
+    it 'fetches all the featured snapshots' do
+      response = VCR.use_cassette('list_public_snapshots_featured') do
+        described_class.list_public_snapshots(featured: true)
+      end
+
+      expect(response['snapshots'].map { |snap| snap['featured'] }).to all(be(true))
+    end
+
+    it 'fetches all the snapshots by given username' do
+      response = VCR.use_cassette('list_public_snapshots_terminal') do
+        described_class.list_public_snapshots(username: 'terminal')
+      end
+
+      expect(response['snapshots'].map { |snap| snap['author'] }).to all(eq('terminal'))
+    end
+
+    it 'fetches all the snapshots with given tag' do
+      response = VCR.use_cassette('list_public_snapshots_ubuntu') do
+        described_class.list_public_snapshots(tag: 'ubuntu')
+      end
+
+      expect(response['snapshots'].map { |snap| snap['tags'] }).to all(include('ubuntu'))
+    end
+
+    it 'fetches all the snapshots with given title' do
+      response = VCR.use_cassette('list_public_snapshots_ubuntu_official') do
+        described_class.list_public_snapshots(title: 'Official Ubuntu 14.04')
+      end
+
+      # Here's a slight caveat, this is not eql, but match. So the following are both valid:
+      # ["Official Ubuntu 14.04", "Haskell Platform on Official Ubuntu 14.04"]
+      expect(response['snapshots'].map { |snap| snap['title'] }).to all(match('Official Ubuntu 14.04'))
+    end
+
+    it 'fetches all the featured snapshots sorted by popularity' do
+      response = VCR.use_cassette('list_public_snapshots_featured_sorted_by_popularity') do
+        described_class.list_public_snapshots(featured: true, sortby: 'popularity')
+      end
+
+      expect(response['snapshots'].map { |snap| snap['featured'] }).to all(be(true))
+
+      start_counts = response['snapshots'].map { |snap| snap['start_count'] }
+      expect(start_counts).to eq(start_counts.sort.reverse)
+    end
+
+    it 'fetches all the featured snapshots sorted by date' do
+      response = VCR.use_cassette('list_public_snapshots_featured_sorted_by_date') do
+        described_class.list_public_snapshots(featured: true, sortby: 'date')
+      end
+
+      expect(response['snapshots'].map { |snap| snap['featured'] }).to all(be(true))
+
+      created_at_dates = response['snapshots'].map { |snap| Date.parse(snap['createdAt']) }
+      expect(created_at_dates).to eq(created_at_dates.sort.reverse)
+    end
+
+    context 'with pagination' do
+      it 'fetches first page of the public snapshots' do
+        response = VCR.use_cassette('list_public_snapshots_page_1') do
+          described_class.list_public_snapshots(page: 1, perPage: 1)
+        end
+
+        expect(response['snapshots'].length).to eq(1)
+      end
+
+      it 'fetches subsequent pages of the public snapshots' do
+        page_one = VCR.use_cassette('list_public_snapshots_page_1') do
+          described_class.list_public_snapshots(page: 1, perPage: 1)
+        end
+
+        page_two = VCR.use_cassette('list_public_snapshots_page_2') do
+          described_class.list_public_snapshots(page: 2, perPage: 1)
+        end
+
+        expect(page_one['snapshots'].length).to eq(1)
+        expect(page_two['snapshots'].length).to eq(1)
+
+        expect(page_one).not_to eql(page_two)
+      end
+    end
+  end
+
+  describe '.count_public_snapshots(**options)' do
+    it 'fetches all the public snapshots by default' do
+      response = VCR.use_cassette('count_public_snapshots') do
+        described_class.count_public_snapshots
+      end
+
+      expect(response['snapshot_count']).to eq(460)
+    end
+
+    it 'fetches all the featured snapshots' do
+      response = VCR.use_cassette('count_public_snapshots_featured') do
+        described_class.count_public_snapshots(featured: true)
+      end
+
+      expect(response['snapshot_count']).to eq(136)
+    end
+
+    it 'fetches all the snapshots by given username' do
+      response = VCR.use_cassette('count_public_snapshots_terminal') do
+        described_class.count_public_snapshots(username: 'terminal')
+      end
+
+      expect(response['snapshot_count']).to eq(55)
+    end
+
+    it 'fetches all the snapshots with given tag' do
+      response = VCR.use_cassette('count_public_snapshots_ubuntu') do
+        described_class.count_public_snapshots(tag: 'ubuntu')
+      end
+
+      expect(response['snapshot_count']).to eq(358)
+    end
+
+    it 'fetches all the snapshots with given title' do
+      response = VCR.use_cassette('count_public_snapshots_ubuntu_official') do
+        described_class.count_public_snapshots(title: 'Official Ubuntu 14.04')
+      end
+
+      # Here's a slight caveat, this is not eql, but match. So the following are both valid:
+      # ["Official Ubuntu 14.04", "Haskell Platform on Official Ubuntu 14.04"]
+      expect(response['snapshot_count']).to eq(17)
+    end
+  end
+end

data/spec/low-level/create_and_manage_terminals_spec.rb

@@ -0,0 +1,199 @@
+describe Terminal do
+  describe '.list_terminals(user_token, access_token)' do
+    it 'lists all my Terminals' do
+      response = VCR.use_cassette('list_terminals') do
+        described_class.list_terminals(user_token, access_token)
+      end
+
+      expect(response['terminals'].length).to eq(2)
+      expect(response['terminals'][0]['name']).to eql('Coding Interview: John Doe Jr')
+    end
+  end
+
+  describe '.get_terminal(user_token, access_token, **options)' do
+    context 'with given container_key' do
+      it 'retrieves info about given Terminal' do
+        response = VCR.use_cassette('get_terminal_with_container_key') do
+          container_key = 'b878c064-fc2b-4f14-81fa-ca10ac9385ff'
+          described_class.get_terminal(user_token, access_token, container_key: container_key)
+        end
+
+        expect(response['terminal']['name']).to eql('Coding Interview: John Doe Jr')
+      end
+    end
+
+    context 'with given subdomain' do
+      it 'retrieves info about given Terminal' do
+        response = VCR.use_cassette('get_terminal_with_subdomain') do
+          described_class.get_terminal(user_token, access_token, subdomain: 'botanicus117')
+        end
+
+        expect(response['terminal']['name']).to eql('Coding Interview: John Doe Jr')
+      end
+    end
+  end
+
+  describe '.start_snapshot(user_token, access_token, snapshot_id, **options)' do
+    it 'should start given snapshot' do
+      response = VCR.use_cassette('start_snapshot') do
+        snapshot_id = '57eff3574ac8d438224dc3aa1c6431a0dbac849a0c254e89be2e758d8113c234'
+        described_class.start_snapshot(user_token, access_token, snapshot_id)
+      end
+
+      response = VCR.use_cassette('start_snapshot_request_progress') do
+        described_class.request_progress(response['request_id'])
+      end
+
+      expect(response['status']).to eql('created')
+    end
+
+    context 'with either cpu or ram' do
+      it 'should raise an argument error if only cpu is provided' do
+        expect {
+          snapshot_id = '57eff3574ac8d438224dc3aa1c6431a0dbac849a0c254e89be2e758d8113c234'
+          described_class.start_snapshot(user_token, access_token, snapshot_id, cpu: '2 (max)')
+        }.to raise_error(ArgumentError)
+      end
+
+      it 'should raise an argument error if only ram is provided' do
+        expect {
+          snapshot_id = '57eff3574ac8d438224dc3aa1c6431a0dbac849a0c254e89be2e758d8113c234'
+          described_class.start_snapshot(user_token, access_token, snapshot_id, ram: 256)
+        }.to raise_error(ArgumentError)
+      end
+    end
+
+    context 'with given cpu and ram' do
+      it 'should start given snapshot with cpu 2 (max) and ram 256' do
+        response = VCR.use_cassette('start_snapshot_valid_cpu_ram') do
+          snapshot_id = '57eff3574ac8d438224dc3aa1c6431a0dbac849a0c254e89be2e758d8113c234'
+          described_class.start_snapshot(user_token, access_token, snapshot_id, cpu: '2 (max)', ram: 256)
+        end
+
+        sleep 16.5 unless File.exist?('spec/low-level/fixtures/start_snapshot_request_progress_valid_cpu_ram.yml')
+
+        response = VCR.use_cassette('start_snapshot_request_progress_valid_cpu_ram') do
+          described_class.request_progress(response['request_id'])
+        end
+
+        expect(response['result']['cpu']).to eql('2 (max)')
+        expect(response['result']['ram']).to eql(256)
+      end
+
+      it 'should start given snapshot with cpu 200 and ram 3200' do
+        response = VCR.use_cassette('start_snapshot_valid_cpu_ram_2') do
+          snapshot_id = '57eff3574ac8d438224dc3aa1c6431a0dbac849a0c254e89be2e758d8113c234'
+          described_class.start_snapshot(user_token, access_token, snapshot_id, cpu: 200, ram: 3200)
+        end
+
+        sleep 16.5 unless File.exist?('spec/low-level/fixtures/start_snapshot_request_progress_valid_cpu_ram_2.yml')
+
+        response = VCR.use_cassette('start_snapshot_request_progress_valid_cpu_ram_2') do
+          described_class.request_progress(response['request_id'])
+        end
+
+        expect(response['result']['cpu']).to eql(200)
+        expect(response['result']['ram']).to eql(3200)
+      end
+    end
+
+    context 'with given name' do
+      it 'should start given snapshot' do
+        response = VCR.use_cassette('start_snapshot_with_name') do
+          snapshot_id = '57eff3574ac8d438224dc3aa1c6431a0dbac849a0c254e89be2e758d8113c234'
+          described_class.start_snapshot(user_token, access_token, snapshot_id, name: 'QA: User Listing #356')
+        end
+
+        sleep 16.5 unless File.exist?('spec/low-level/fixtures/start_snapshot_request_progress_with_name.yml')
+
+        response = VCR.use_cassette('start_snapshot_request_progress_with_name') do
+          described_class.request_progress(response['request_id'])
+        end
+
+        expect(response['result']['name']).to eql('QA: User Listing #356')
+      end
+    end
+
+    context 'with autopause on' do
+      it 'should start given snapshot' do
+        response = VCR.use_cassette('start_snapshot_with_autopause_on') do
+          snapshot_id = '57eff3574ac8d438224dc3aa1c6431a0dbac849a0c254e89be2e758d8113c234'
+          described_class.start_snapshot(user_token, access_token, snapshot_id, autopause: true)
+        end
+
+        sleep 16.5 unless File.exist?('spec/low-level/fixtures/start_snapshot_request_progress_with_autopause_on.yml')
+
+        response = VCR.use_cassette('start_snapshot_request_progress_with_autopause_on') do
+          described_class.request_progress(response['request_id'])
+        end
+
+        # Autopause isn't propagated to the result object.
+        # If this succeeded, we expect everything to be OK.
+      end
+    end
+
+    context 'with autopause off' do
+      it 'should start given snapshot' do
+        response = VCR.use_cassette('start_snapshot_with_autopause_off') do
+          snapshot_id = '57eff3574ac8d438224dc3aa1c6431a0dbac849a0c254e89be2e758d8113c234'
+          described_class.start_snapshot(user_token, access_token, snapshot_id, autopause: false)
+        end
+
+        sleep 16.5 unless File.exist?('spec/low-level/fixtures/start_snapshot_request_progress_with_autopause_off.yml')
+
+        response = VCR.use_cassette('start_snapshot_request_progress_with_autopause_off') do
+          described_class.request_progress(response['request_id'])
+        end
+
+        # Autopause isn't propagated to the result object.
+        # If this succeeded, we expect everything to be OK.
+      end
+    end
+
+    context 'with temporary on' do
+      it 'should start given snapshot' do
+        response = VCR.use_cassette('start_snapshot_with_temporary_on') do
+          snapshot_id = '57eff3574ac8d438224dc3aa1c6431a0dbac849a0c254e89be2e758d8113c234'
+          described_class.start_snapshot(user_token, access_token, snapshot_id, temporary: true)
+        end
+
+        sleep 16.5 unless File.exist?('spec/low-level/fixtures/start_snapshot_request_progress_with_temporary_on.yml')
+
+        response = VCR.use_cassette('start_snapshot_request_progress_with_temporary_on') do
+          described_class.request_progress(response['request_id'])
+        end
+
+        # Temporary isn't propagated to the result object.
+        # If this succeeded, we expect everything to be OK.
+      end
+    end
+
+    context 'with temporary off' do
+      it 'should start given snapshot' do
+        response = VCR.use_cassette('start_snapshot_with_temporary_off') do
+          snapshot_id = '57eff3574ac8d438224dc3aa1c6431a0dbac849a0c254e89be2e758d8113c234'
+          described_class.start_snapshot(user_token, access_token, snapshot_id, temporary: false)
+        end
+
+        sleep 16.5 unless File.exist?('spec/low-level/fixtures/start_snapshot_request_progress_with_temporary_off.yml')
+
+        response = VCR.use_cassette('start_snapshot_request_progress_with_temporary_off') do
+          described_class.request_progress(response['request_id'])
+        end
+
+        # Temporary isn't propagated to the result object.
+        # If this succeeded, we expect everything to be OK.
+      end
+    end
+
+    # :temporary, :startup_script, :custom_data)
+    #
+    #   "result"=>{"cpu"=>"2 (max)", "ram"=>256, "diskspace"=>10,
+    #     "name"=>"Ubuntu 14.04 Base Dev Snapshot",
+    #     "snapshot_id"=>"57eff3574ac8d438224dc3aa1c6431a0dbac849a0c254e89be2e758d8113c234",
+    #     "status"=>"running", "allow_spot"=>false,
+    #     "container_key"=>"d6e9e1ee-d334-4027-b365-5d7eebe5a1d7",
+    #     "subdomain"=>"botanicus221", "container_ip"=>"240.3.42.64",
+    #     "creation_time"=>1417452412482}}
+  end
+end