onescreen-api-client 0.0.2

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2010 OneScreen
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,19 @@
+= onescreen-api-client
+
+Is tool to be used against the OneScreen API. It allows clients to build their own interface to front the OneScreen Service.
+
+== Contributing to onescreen-api-client
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2010 OneScreen Inc. See LICENSE.txt for
+further details.
+

data/lib/onescreen-api-client.rb

@@ -0,0 +1,14 @@
+require 'active_resource'
+$:.unshift(File.dirname(__FILE__))
+require 'resources/base'
+require 'resources/account'
+require 'resources/asset'
+require 'resources/error'
+require 'resources/login'
+require 'resources/media_source'
+require 'resources/networks_affiliate'
+require 'resources/player'
+require 'resources/playlist'
+require 'resources/signup'
+require 'resources/site'
+require 'resources/user'

data/lib/resources/account.rb

@@ -0,0 +1,28 @@
+module OneScreen
+  class Account < OneScreenBase
+  
+    schema do
+      # Readable + Writable Properties
+      string 'organization', 'primary_website', 'address1', 'address2', 'city', 
+             'state', 'postal_code', 'country', 'phone', 'fax', 'tax_identifier'
+      
+      # Readable Only Properties
+      # TODO: Unsupported type conversions Should be left as string
+      integer 'created_by', 'modified_by'
+      string 'row_version', 'created_at', 'modified_at'
+    end    
+    
+    validates :organization, :presence => true, :length => {:minimum=>3,:maximum=>100}
+    validates :primary_website, :length => {:minimum=>5,:maximum=>100}
+    validates :address1, :length => {:maximum=>100}
+    validates :address2, :length => {:maximum=>100}
+    validates :city, :length => {:maximum=>100}
+    validates :state, :length => {:minimum=>2,:maximum=>75}
+    validates :postal_code, :length => {:minimum=>5,:maximum=>15}
+    validates :country, :length => {:minimum=>2,:maximum=>75}
+    validates :phone, :length => {:minimum=>9,:maximum=>100}
+    validates :fax, :length => {:minimum=>9,:maximum=>15}
+    validates :tax_identifier, :length => {:minimum=>5,:maximum=>100}
+    
+  end
+end

data/lib/resources/asset.rb

@@ -0,0 +1,20 @@
+module OneScreen
+  class Asset < OneScreenBase
+    read_only :uri
+    
+    schema do
+      # Readable + Writable Properties
+      string 'name', 'tags'
+      
+      # Readable Only Properties
+      # TODO: Unsupported type conversions Should be left as string
+      integer 'account_id', 'parent_id', 'created_by', 'modified_by'
+      string 'row_version', 'created_at', 'modified_at'
+    end
+    
+    validates :name, :presence => true, :length => {:minimum=>5,:maximum=>100}
+    validates :account_id, :numericality => true
+    validates :tags, :length => {:maximum=>500}
+   
+  end
+end

data/lib/resources/base.rb

@@ -0,0 +1,44 @@
+module OneScreen
+  class OneScreenBase < ActiveResource::Base
+         
+    self.timeout = 20
+    self.site = "http://api.onescreen.net/"
+    # self.format = ActiveResource::Formats::JsonFormat
+    
+    class << self
+      attr_reader :read_only_attributes
+      
+      def read_only(*values)
+        @read_only_attributes ||= []
+        @read_only_attributes.concat(values)
+			  @read_only_attributes.uniq!
+      end 
+    
+      # If headers are not defined in a given subclass, then obtain
+      # headers from the superclass.
+      def headers
+        if defined?(@headers)
+          @headers
+        elsif superclass != Object && superclass.headers
+          superclass.headers
+        else
+          @headers ||= {}
+        end
+      end
+    end  
+    
+    def remove_read_only
+      self.class.read_only_attributes.each do |attr|
+        attributes.delete(attr)
+      end
+    end
+    
+    def self.set_authentication_cookie(value)
+      self.headers.merge!("Cookie" => value)
+    end 
+    def set_authentication_cookie(value)
+      self.class.headers.merge!("Cookie" => value)
+    end
+    
+  end
+end

data/lib/resources/error.rb

@@ -0,0 +1,5 @@
+module OneScreen
+  class Error < OneScreenBase
+  
+  end 
+end

data/lib/resources/login.rb

@@ -0,0 +1,12 @@
+module OneScreen
+  class Login < OneScreenBase 
+     
+    set_collection_name 'login' 
+     
+    schema do
+      string 'username', 'password', 'authentication_key'
+      integer 'user_id', 'account_id'
+    end
+    
+  end  
+end

data/lib/resources/media_source.rb

@@ -0,0 +1,29 @@
+module OneScreen
+  class MediaSource < OneScreenBase
+    
+    schema do
+      # Readable + Writable Properties
+      string 'name', 'short_description', 'long_description', 'tags'
+      integer  'parent_id', 'media_source_type_id'
+      
+      # Readable Only Properties
+      # TODO: Unsupported type conversions Should be left as string
+      integer 'account_id', 'created_by', 'modified_by'
+      string 'row_version', 'created_at', 'modified_at', 'last_published_date'
+    end
+    
+    validates :name, :presence => true, :length => {:minimum=>5,:maximum=>100}
+    validates :short_description, :length => {:maximum=>300}
+    validates :long_description, :length => {:maximum=>2000}
+    validates :tags, :length => {:maximum=>500}    
+    validates :media_source_type_id, :presence => true, :numericality => true
+   
+    public          
+    def thumbnail_image  
+      self.respond_to?(:thumbnail) ? self.thumbnail.uri : "http://mp.onescreen.net/u/a_mc/1000500/i/1000500_DA_OTk0NDUwMA==.jpg"
+    end    
+    def preview_url
+      self.respond_to?(:preview) ? self.preview.uri : nil #"http://r.onescreen.net/f/OTk0NDQ4MA==";
+    end
+  end  
+end

data/lib/resources/networks_affiliate.rb

@@ -0,0 +1,20 @@
+module OneScreen
+  class NetworksAffiliate < OneScreenBase
+    
+    schema do
+      # Readable + Writable Properties
+      integer 'network_account_id', 'affiliate_account_id'
+      string 'is_approved'
+      
+      # Readable Only Properties
+      # TODO: Unsupported type conversions Should be left as string
+      string 'network_account_name', 'affiliate_account_name'
+      string 'row_version', 'approved_at', 'is_approved'
+    end
+   
+    validates :network_account_id, :presence => true, :numericality => true
+    validates :affiliate_account_id, :presence => true, :numericality => true
+    validates :is_approved, :inclusion => [true,false]
+   
+  end  
+end

data/lib/resources/player.rb

@@ -0,0 +1,103 @@
+module OneScreen
+  class Player < OneScreenBase
+  
+    attr_reader :settings_hash
+   
+    schema do
+      # Readable + Writable Properties
+      string 'name', 'description', 'url', 'settings'
+      
+      # Readable Only Properties
+      # TODO: Unsupported type conversions Should be left as string
+      integer 'account_id', 'created_by', 'modified_by'
+      string 'row_version', 'created_at', 'modified_at'
+    end
+    
+    validates :name, :presence => true, :length => {:minimum=>5,:maximum=>100}
+    validates :url, :presence => true, :length => {:maximum=>250}
+    validates :settings, :presence => true, :length => {:maximum=>200}       
+    validates :description, :length => {:maximum=>2000}
+    
+    public     
+    def skin_mapping
+      { 
+        "http://cdn.onescreen.net/os/mp/osmp/iframeAds/skins/white.xml" => "FFFFFF",
+        "http://cdn.onescreen.net/os/mp/osmp/iframeAds/skins/embeddableSkin.xml" => "666666",
+        "http://cdn.onescreen.net/os/mp/osmp/iframeAds/skins/blueSkin.xml" => "4E6395",
+        "http://cdn.onescreen.net/os/mp/osmp/iframeAds/skins/realblueSkin.xml" => "097BBD",
+        "http://cdn.onescreen.net/os/mp/osmp/iframeAds/skins/lightblueSkin.xml" => "8290D1",
+        "http://cdn.onescreen.net/os/mp/osmp/iframeAds/skins/pinkSkin.xml" => "9F639E",
+        "http://cdn.onescreen.net/os/mp/osmp/iframeAds/skins/redSkin.xml" => "8F201A",
+        "http://cdn.onescreen.net/os/mp/osmp/iframeAds/skins/skin_hollyscoop.xml" => "CD3300",
+        "http://cdn.onescreen.net/os/mp/osmp/iframeAds/skins/greenSkin.xml" => "6B8429"      
+      } 
+    end
+      
+    def volume()
+      val = settings_hash[:rs_vol]
+      (val.to_f * 100).to_i if val
+    end
+    
+    def is_player_skin(value)
+      if settings_hash[:ds_skin] and skin_mapping[settings_hash[:ds_skin]] == value
+        return "color_selected"
+      end
+    end
+    
+    def get_skin_code
+      skin_mapping[settings_hash[:ds_skin]] if settings_hash[:ds_skin]
+    end
+
+    def get_size_code
+      ds_w = settings_hash[:ds_w] || 0
+      ds_h = settings_hash[:ds_h] || 0
+      ds_plx = settings_hash[:ds_plx] || 0
+      ds_ply = settings_hash[:ds_ply] || 0
+      
+      width = ds_w.to_i + ds_plx.to_i
+      height = ds_h.to_i + ds_ply.to_i
+      width.to_s + "x" + height.to_s
+    end
+      
+    def get_no_playlist   
+      "selected" if settings and not settings.include?("ds_plx=")
+    end
+    
+    def get_vertical_playlist
+      "selected" if settings and settings.include?("ds_plx=") and settings_hash[:ds_plx].to_i == 0
+    end
+    
+    def get_horizontal_playlist
+      "selected" if settings and settings.include?("ds_plx=") and settings_hash[:ds_plx].to_i > 0
+    end
+    
+    def get_width_height(w,h)
+      "selected" if settings and settings.include?("ds_w=#{w}") and settings.include?("ds_h=#{h}")
+    end
+    
+    def get_width_horizontal(plx)
+      "selected" if settings and settings.include?("ds_plx=#{plx}")
+    end
+
+    def get_height_vertical(ply)
+      "selected" if settings and settings.include?("ds_ply=#{ply}")
+    end  
+    
+    def set_settings_hash
+      @settings_hash = {}    
+      unless settings.blank?           
+        settings.split(/&/).each do |setting|
+          unless setting.blank?
+            key,value = setting.split(/=/)
+            @settings_hash[key.to_sym] = value
+          end
+        end    
+      end
+      @settings_hash 
+    end
+    
+    def settings_hash
+      @settings_hash ||= set_settings_hash
+    end
+  end 
+end

data/lib/resources/playlist.rb

@@ -0,0 +1,28 @@
+module OneScreen
+  class Playlist < OneScreenBase
+    schema do
+      # Readable + Writable Properties
+      string 'name', 'short_description', 'long_description', 'tags', 'last_published_date'
+      integer  'playlist_type_id' 
+      
+      # Readable Only Properties
+      # TODO: Unsupported type conversions Should be left as string
+      integer 'account_id', 'created_by', 'modified_by'
+      string 'row_version', 'created_at', 'modified_at', 
+    end
+        
+    validates :name, :presence => true, :length => {:minimum=>5,:maximum=>100}
+    validates :short_description, :length => {:maximum=>300}
+    validates :long_description, :length => {:maximum=>2000}
+    validates :tags, :length => {:maximum=>500}    
+    validates :playlist_type_id, :presence => true, :numericality => true
+    
+    public
+    def videos
+      self.media_sources if self.respond_to?(:media_sources)
+    end    
+    def deploy_url
+      OneScreen::Config.get_value("onescreen", "cdn_path") + "#{self.account_id}/p/#{self.id}.xml"
+    end        
+  end
+end

data/lib/resources/signup.rb

@@ -0,0 +1,20 @@
+module OneScreen
+  class Signup < OneScreenBase
+    
+    schema do
+      # Readable + Writable Properties
+      string 'username', 'account_name', 'password', 'email', 'confirmation_redirect_url'
+      
+      # Readable Only Properties
+      # TODO: Unsupported type conversions Should be left as string
+      string 'created_at', 'guid'
+    end
+    
+    validates :account_name, :presence => true, :length => {:minimum=>5,:maximum=>50}
+    validates :username, :presence => true, :length => {:minimum=>5,:maximum=>50}
+    validates :password, :presence => true, :length => {:minimum=>6}
+    validates :email, :presence => true, :length => {:minimum=>5,:maximum=>150}, :format => { :with=> /\A([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})\Z/i }
+    validates :confirmation_redirect_url, :length => {:minimum=>5,:maximum=>500}
+    
+  end
+end

data/lib/resources/site.rb

@@ -0,0 +1,25 @@
+module OneScreen
+  class Site < OneScreenBase
+    
+    schema do
+      # Readable + Writable Properties
+      string 'name', 'description', 'url',
+             'account_relationship', 'rep_firm', 'has_video', 'only_video', 'embed_video', 'video_platform',
+             'video_ad_sales', 'video_ad_networks', 'video_views', 'user_gen', 'register_required', 'privacy_policy',
+             'terms_conditions', 'traffic_sources', 'traffic_measurment', 
+             'visitors_monthly_us', 'visitors_daily_us', 'page_views_us',
+             'visitors_monthly_intl', 'visitors_daily_intl', 'page_views_intl',
+             'auto_refresh', 'audience_gender', 'audience_age', 'audience_income'
+             
+      # Readable Only Properties
+      # TODO: Unsupported type conversions Should be left as string
+      integer 'account_id', 'created_by', 'modified_by'      
+      string 'row_version', 'created_at', 'modified_at'
+    end
+    
+    validates :name, :presence => true, :length => {:minimum=>5,:maximum=>100}
+    validates :description, :length => {:maximum=>2000}
+    validates :url, :presence => true, :length => {:maximum=>250}          
+    
+  end
+end

data/lib/resources/user.rb

@@ -0,0 +1,35 @@
+module OneScreen
+  class User < OneScreenBase
+    
+    schema do
+      # Readable + Writable Properties
+      string 'user_name', 'first_name', 'last_name', 'email', 'title', 
+             'department', 'address1', 'address2', 'city', 'state', 'postal_code', 
+             'country', 'office_phone', 'mobile_phone', 'other_phone', 'fax'
+      
+      # Readable Only Properties
+      # TODO: Unsupported type conversions Should be left as string
+      integer 'account_id', 'created_by', 'modified_by'
+      string 'row_version', 'created_at', 'modified_at'
+    end
+    
+    validates :user_name, :presence => true, :length => {:minimum=>3,:maximum=>100}
+    validates :email, :presence => true, :length => {:minimum=>5,:maximum=>150}, :format => { :with=> /\A([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})\Z/i }
+    validates :department, :length => {:maximum=>50}
+    validates :address1, :length => {:maximum=>100}
+    validates :address2, :length => {:maximum=>100}
+    validates :city, :length => {:maximum=>100}
+    validates :state, :length => {:minimum=>2,:maximum=>75}
+    validates :postal_code, :length => {:minimum=>5,:maximum=>15}
+    validates :country, :length => {:minimum=>2,:maximum=>75}
+    validates :office_phone, :length => {:minimum=>9,:maximum=>100}
+    validates :mobile_phone, :length => {:minimum=>9,:maximum=>100}
+    validates :other_phone, :length => {:minimum=>9,:maximum=>100}
+    validates :fax, :length => {:minimum=>9,:maximum=>15}
+    
+    public
+      def username
+        self.user_name
+      end
+  end
+end

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification 
+name: onescreen-api-client
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- OneScreen Inc.
+- Nirmit Patel
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-14 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activeresource
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 5
+        - 1
+        version: 1.5.1
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: activeresource
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 4
+        version: 3.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: *id006
+description: This gem is designed to be used by consumers that wish to connect to the OneScreen API via a ruby plugin. The client that wishes to use this service will need to provide an api-key that will be supplied after registering with OneScreen.
+email: npatel@onescreen.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- ChangeLog.txt
+- LICENSE.txt
+- README.rdoc
+files: 
+- lib/onescreen-api-client.rb
+- lib/resources/account.rb
+- lib/resources/asset.rb
+- lib/resources/base.rb
+- lib/resources/error.rb
+- lib/resources/login.rb
+- lib/resources/media_source.rb
+- lib/resources/networks_affiliate.rb
+- lib/resources/player.rb
+- lib/resources/playlist.rb
+- lib/resources/signup.rb
+- lib/resources/site.rb
+- lib/resources/user.rb
+- ChangeLog.txt
+- LICENSE.txt
+- README.rdoc
+has_rdoc: true
+homepage: http://github.com/onescreen/api-client
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 462723471
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: This gem is designed to be used by consumers that wish to connect to the OneScreen API via a ruby plugin.
+test_files: []
+