everybit 0.1.0

data/lib/everybit.rb

@@ -0,0 +1,78 @@
+# Everybit Ruby Library
+# API docs at http://dev.everybit.co
+
+require 'rest_client'
+require 'multi_json'
+
+# version
+require 'everybit/version'
+
+# restful modules
+require 'everybit/modules/listable'
+require 'everybit/modules/deleteable'
+require 'everybit/modules/createable'
+require 'everybit/modules/updateable'
+
+# resources
+require 'everybit/everybit_object'
+require 'everybit/resource'
+require 'everybit/collection'
+require 'everybit/account'
+require 'everybit/video'
+
+# Errors
+require 'everybit/errors/everybit_error'
+require 'everybit/errors/authentication_error'
+
+module Everybit
+  @@api_key  = nil
+  @@api_base = 'https://api.everybit.co'
+
+  def self.api_url(url='')
+    api_base + url
+  end
+
+  def self.api_key=(api_key)
+    @@api_key = api_key
+  end
+
+  def self.api_key
+    @@api_key
+  end
+
+  def self.api_base=(api_base)
+    @@api_base = api_base
+  end
+
+  def self.api_base
+    @@api_base
+  end
+
+  def self.request(method, url, params={}, headers={})
+    # we can't do anything without an api key, so bail early
+    raise AuthenticationError.new('No API key provided (set API key using "Everybit.api_key = API_KEY")') unless self.api_key
+
+    # prepare headers
+    headers = {
+      :user_agent => "everybit-ruby/#{Everybit::VERSION}",
+      'x-apikey' => self.api_key
+    }.merge(headers)
+
+    # assemble all the options for the request
+    opts = {
+      method:  method,
+      url:     self.api_url(url),
+      headers: headers,
+      payload: MultiJson.dump(params)
+    }
+
+    # execute request
+    MultiJson.load(send_request(opts), symbolize_keys: true)
+  end
+
+  private
+
+  def self.send_request(opts)
+    RestClient::Request.execute(opts)
+  end
+end

data/spec/account_spec.rb

@@ -0,0 +1,46 @@
+# -*- coding: utf-8 -*-
+require 'spec_helper'
+
+# this file contains all the tests related to
+# requesting account details from the Everybit api
+
+describe Everybit, 'Account Specs' do
+
+  before do
+    Everybit.api_key = '1a2b3c4d5e6f7g8h9i'
+    @params = {mock_response: 'mock_account'}
+  end
+
+  after do
+    Everybit.api_key = nil
+  end
+
+  it 'should wrap the response in an Everybit::Account object' do
+    Everybit::Account.retrieve(@params).must_be_instance_of Everybit::Account
+  end
+
+  it 'should create the correct url' do
+    res = Everybit::Account.retrieve(@params)
+    res[:opts][:url].must_equal 'https://api.everybit.co/v1/account'
+  end
+
+  it 'should create a code attribute' do
+    res = Everybit::Account.retrieve(@params)
+    res.code.must_equal 200
+  end
+
+  it 'should create a status attribute' do
+    res = Everybit::Account.retrieve(@params)
+    res.status.must_equal true
+  end
+
+  it 'should expose returned data' do
+    res = Everybit::Account.retrieve(@params)
+    res[:uuid].must_equal '787c8956-1857-4771-9d4e-b99b4dedfeae'
+    res[:email].must_equal 'jsmith@example.com'
+    res[:username].must_equal 'jsmith'
+    res[:first_name].must_equal 'John'
+    res[:last_name].must_equal 'Smith'
+  end
+
+end # Account Specs

data/spec/misc_spec.rb

@@ -0,0 +1,49 @@
+# -*- coding: utf-8 -*-
+require 'spec_helper'
+
+# this file contains all the miscellaneous tests
+# that don't fit nicely into any other category
+
+describe Everybit, 'Miscellaneous Specs' do
+
+  describe 'module level variables and instance methods' do
+
+    before do
+      @default_base_url = 'https://api.everybit.co'
+    end
+    
+    it 'should have no api key by default' do
+      Everybit.api_key.must_be_nil
+    end
+
+    it 'should accept a new api key' do
+      Everybit.api_key = '1a2b3c4d5e6f7g8h9'
+      Everybit.api_key.must_equal '1a2b3c4d5e6f7g8h9'
+      Everybit.api_key = nil
+    end
+
+    it 'should have a default base api url' do
+      Everybit.api_base.must_equal @default_base_url
+    end
+
+    it 'should accept a new base api url' do
+      Everybit.api_base = 'http://staging.api.everybit.co'
+      Everybit.api_base.must_equal 'http://staging.api.everybit.co'
+      Everybit.api_base = @default_base_url
+    end
+
+    it 'should build a url using the base api url' do
+      Everybit.api_url.must_equal @default_base_url
+      Everybit.api_url('/media').must_equal @default_base_url + '/media'
+    end
+
+    it 'should require an api key when calling request()' do
+      Everybit.api_key = nil
+      assert_raises Everybit::AuthenticationError do
+        Everybit.request(:get, '/media')
+      end
+    end
+
+  end # module level variables and instance methods
+
+end # Miscellaneous Specs

data/spec/spec_helper.rb

@@ -0,0 +1,277 @@
+# -*- coding: utf-8 -*-
+# use minitest gem, not the one from stdlib
+gem     'minitest'
+
+require 'minitest/autorun'
+require 'turn'
+require 'everybit'
+
+# override the request method so it returns
+# mock responses during testing
+module Everybit
+  def self.send_request(opts)
+    payload = MultiJson.load(opts[:payload], symbolize_keys: true)
+    res = send(payload[:mock_response], opts)
+    MultiJson.dump(res)
+  end
+end
+
+def mock_account(opts={})
+  {
+    code: 200,
+    status: true,
+    data: {
+      opts: opts,
+      uuid: '787c8956-1857-4771-9d4e-b99b4dedfeae',
+      email: 'jsmith@example.com',
+      username: 'jsmith',
+      first_name: 'John',
+      last_name: 'Smith'
+    }
+  }
+end
+
+def mock_all_videos(opts={})
+  videos = mock_video_details(opts)
+  video = videos[:data]
+  {
+    code: 200,
+    status: true,
+    data: [video, video, video]
+  }
+end
+
+def mock_video_details(opts={})
+  {
+    code: 200,
+    status: true,
+    data: {
+      opts: opts,
+      uuid: '787c8956-1857-4771-9d4e-b99b4dedfeae',
+      owner_uuid: '787c8956-1857-4771-9d4e-b99b4dedfeae',
+      created_date: '1234567890',
+      last_updated: '1234567890',
+      visibility: 'private',
+      title: 'Video Title',
+      summary: 'A short description about the media.',
+      duration: 45347,
+      type: 'video',
+      source_url: 'http://static.everybit.co/787c8956-1857-4771-9d4e-b99b4dedfeae.mov',
+      player_url: 'http://static.everybit.co/player/787c8956-1857-4771-9d4e-b99b4dedfeae',
+      thumbnail: 'http://static.everybit.co/PATH_TO_FILE',        
+      lat: '45.4535345',
+      lon: '32.3245344',
+      play_count: false,
+      data_consumed: 100,
+      player_attributes: mock_video_player_attributes,
+      media_info: mock_video_media_info,
+      versions: [
+        mock_video_versions,
+        mock_video_versions,
+        mock_video_versions,
+        mock_video_versions,
+        mock_video_versions,
+        mock_video_versions,
+        mock_video_versions,
+        mock_video_versions
+      ]
+    }
+  }
+end
+
+def mock_video_status(opts={})
+  {
+    code: 200,
+    status: true,
+    data: {
+      opts: opts,
+      uuid: '787c8956-1857-4771-9d4e-b99b4dedfeae',
+      processing: true,
+      progress: 50,
+      completed: false,
+      completed_date: nil
+    }
+  }
+end
+
+def mock_create_video_success(opts={})
+  {
+    code: 200,
+    status: true,
+    data: {
+      uuid: '787c8956-1857-4771-9d4e-b99b4dedfeae',
+      opts: opts
+    }
+  }
+end
+
+def mock_create_video_error(opts={})
+  {
+    code: 200,
+    status: false,
+    data: {
+      opts: opts,
+      error: 'some error message here'
+    }
+  }
+end
+
+def mock_delete_video_success(opts={})
+  {
+    code: 200,
+    status: true,
+    data: {
+      opts: opts,
+      message: 'your video was deleted successfully'
+    }
+  }
+end
+
+def mock_delete_video_error(opts={})
+  {
+    code: 200,
+    status: false,
+    data: {
+      opts: opts,
+      error: 'some error message here'
+    }
+  }
+end
+
+def mock_update_video_success(opts={})
+  {
+    code: 200,
+    status: true,
+    data: {
+      opts: opts,
+      message: 'your video was updated successfully'
+    }
+  }
+end
+
+def mock_update_video_error(opts={})
+  {
+    code: 200,
+    status: false,
+    data: {
+      opts: opts,
+      error: 'some error message here'
+    }
+  }
+end
+
+private
+
+# mock video details versions response
+def mock_video_versions
+  {
+    name: 'medium',
+    type: 'video/mp4',            
+    rtmpStream: 'rtmp://static.everybit.co/PATH_TO_FILE',
+    httpStream: 'http://static.everybit.co:1935/PATH_TO_FILE',
+    rtspStream: 'rtsp://static.everybit.co:1935/PATH_TO_FILE',
+    progressiveDownload: 'http://static.everybit.co/PATH_TO_FILE'
+  }
+end
+
+# mock video details media info response
+def mock_video_media_info
+  {
+    container: 'MPEG-4',
+    format_profile: 'QuickTime',
+    codec_id: 'qt',
+    file_size: 9466208,
+    duration: 4903, 
+    overall_bit_rate: 16252928,
+    encoded_date: '2011-08-31 18:34:30',
+    tagged_date: '2011-08-31 18:34:30',
+    writing_library: 'Apple QuickTime',
+    video_format: 'AVC',
+    video_format_info: 'Advanced Video Codec',
+    video_format_profile: 'Main@L4.0',
+    video_format_settings_c_a_b_a_c: 'true',
+    video_format_settings_re_frames: '2 frames',
+    video_codec_id: 'avc1',
+    video_codec_id_info: 'Advanced Video Coding',
+    video_duration: 4903,
+    video_bit_rate: 14575206.4,
+    video_width: 1920,
+    video_height: 1080,
+    video_display_aspect_ratio: '16:9',
+    video_frame_rate_mode: 'Constant',
+    video_frame_rate: 29.970,
+    video_color_space: 'YUV',
+    video_chroma_subsampling: '4:2:0',
+    video_bit_depth: 8, 
+    video_scan_type: 'Progressive',
+    video_bits_pixel_frame: 0.224,
+    video_stream_size: 8524920,
+    video_language: 'English',
+    video_color_primaries: 'BT.709-5, BT.1361, IEC 61966-2-4, SMPTE RP177',
+    video_transfer_characteristics: 'BT.709-5, BT.1361',
+    video_matrix_coefficients: 'BT.709-5, BT.1361, IEC 61966-2-4 709, SMPTE RP177',      
+    audio_format: 'PCM',
+    audio_format_settings_endianness: 'Little',
+    audio_format_settings_sign: 'Signed',
+    audio_codec_id: 'sowt',
+    audio_duratio: 4903,
+    audio_bit_rate_mode: 'Constant',
+    audio_bit_rate: 1572864,
+    audio_channels: '2 channels',
+    audio_channel_positions: 'Front: L R',
+    audio_sampling_rate: '48.0 KHz',
+    audio_bit_depth: 16,
+    audio_stream_size: 941056,
+    audio_language: 'English',
+    image_format: 'PNG',
+    image_format_info: 'Portable Network Graphic',
+    image_file_size: 434176,
+    image_sub_format: 'LZ77',
+    image_width: 572,
+    image_height: 450,
+    image_resolution: 32
+  }
+end
+
+# mock video details player attributes response
+def mock_video_player_attributes
+  {
+    template_name: 'default',
+    width: 640,
+    height: 360,
+    hold_frame: 'http://example.com/custom_hold_frame',
+    show_hold_frame: true,
+    sharing_enabled: true,
+    show_email_share: true,
+    show_embed_share: true,
+    show_social_share: true,
+    auto_play: false,
+    scaling: 'fit',
+    fade_in_speed: 0,
+    fade_out_speed: 0,
+    start_time: 0.000,
+    duration: 0.000,
+    show_controls: true,
+    auto_hide_controls: true,
+    auto_hide_controls_fullscreen_only: false,
+    auto_hide_controls_delay: 10000,
+    hardware_accelerated: false,
+    background_color: '#000000',
+    background_gradient: 'low',
+    time_color: '#01DAFF',
+    duration_color: '#FFFFFF',
+    progress_color: '#015B7A',
+    progress_gradient: 'medium',
+    buffer_color: '#6C9CBC',
+    buffer_gradient: 'none',
+    slider_color: '#000000',
+    slider_gradient: 'none',
+    button_color: '#889AA4',
+    button_over_color: '#92B2BD',
+    volume_slider_color: '#000000',
+    volume_color: '#000000',
+    volume_slider_gradient: 'none',
+    time_background_color: '#555555',
+    time_border_color: '#FFFFFF'
+  }
+end