littlstar 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7e5b3421dd7f891ad026e817e810d41a87b4f8ce
+  data.tar.gz: 97acb20149cb7a8066a801559515af8d94503879
+SHA512:
+  metadata.gz: 5b8409c18cb9eabb350040506f69955d60706d75c3b52f86294886a8de937104c9eadb756444c1649c90cda105a79d22f53786577445ee7a1f0387e346523751
+  data.tar.gz: b3dfa0e3e35e178a2b03f69dc9292aada3b6bf07110f00f987a37b42c4d5eca9960325993635c7b8a7200fe74e0c3367a924504179a7792c1e2491418ff398f5

data/.gitignore

@@ -0,0 +1,10 @@
+.DS_Store
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.5

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in littlstar.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Little Star Media, Inc.
+
+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.md

@@ -0,0 +1,199 @@
+# Littlstar Ruby Gem
+
+This gem encapsulates the functionality needed to access content through the Littstar API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'littlstar'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install littlstar
+```
+
+## Usage
+
+This gem defines seven classes that mimic the current Littlstar V1 API endpoints. These classes can be instantiated to interact with each endpoint individually and define the methods that are supported by their corresponding endpoints. Example responses for all endpoints can be found in the relevant sections of the Littlstar [API documentation](http://developer.littlstar.com/docs/).
+
+### Search
+
+API search endpoints can be accessed through the `Littlstar::Search` class.
+
+```ruby
+ls_search = Littlstar::Search.new
+
+# Search across videos, photos, users, and channels
+ls_search.all(q: 'search query')
+
+# Search only videos
+ls_search.videos(q: 'search query')
+
+# Search only Photos
+ls_search.photos(q: 'search query')
+
+# Search only Users
+ls_search.users(q: 'search query')
+
+# Search only Channels
+ls_search.channels(q: 'search query')
+```
+
+### Users
+
+API user endpoints can be accessed through the `Littlstar::Users` class.
+
+```ruby
+ls_users = Littlstar::Users.new
+
+# Get a single user
+ls_users.get(id)
+
+# Get a single user's videos
+ls_users.videos_for(id, {optional: 'query_params_hash'})
+
+# Get a single user's photos
+ls_users.photos_for(id, {optional: 'query_params_hash'})
+
+# Get a single user's channels
+ls_users.channels_for(id, {optional: 'query_params_hash'})
+
+# Get a single user's followers
+ls_users.followers_for(id, {optional: 'query_params_hash'})
+
+# Get users currently followed by a single user
+ls_users.following_for(id, {optional: 'query_params_hash'})
+```
+
+### Videos
+
+API video endpoints can be accessed through the `Littlstar::Videos` class.
+
+```ruby
+ls_videos = Littlstar::Videos.new
+
+# Get a single video
+ls_videos.get(id)
+
+# Get all videos
+ls_videos.all({optional: 'query_params_hash'})
+
+# Get sponsored videos
+ls_videos.sponsored({optional: 'query_params_hash'})
+
+# Get featured videos
+ls_videos.featured({optional: 'query_params_hash'})
+
+# Get latest videos
+ls_videos.latest({optional: 'query_params_hash'})
+
+# Get VR videos
+ls_videos.vr({optional: 'query_params_hash'})
+
+# Get comments for a video
+ls_videos.comments_for(id, {optional: 'query_params_hash'})
+```
+
+### Photos
+
+API photo endpoints can be accessed through the `Littlstar::Photos` class.
+
+```ruby
+ls_photos = Littlstar::Photos.new
+
+# Get a single photo
+ls_photos.get(id)
+
+# Get all photos
+ls_photos.all({optional: 'query_params_hash'})
+
+# Get featured photos
+ls_photos.featured({optional: 'query_params_hash'})
+
+# Get latest photos
+ls_photos.latest({optional: 'query_params_hash'})
+
+# Get VR photos
+ls_photos.vr({optional: 'query_params_hash'})
+
+# Get comments for a video
+ls_photos.comments_for(id, {optional: 'query_params_hash'})
+```
+
+### Categories
+
+API category endpoints can be accessed through the `Littlstar::Categories` class.
+
+```ruby
+ls_categories = Littlstar::Categories.new
+
+# Get a single category
+ls_categories.get(id)
+
+# Get all categories
+ls_categories.all({optional: 'query_params_hash'})
+
+# Get single category videos
+ls_categories.videos_for(id, {optional: 'query_params_hash'})
+
+# Get single category photos
+ls_categories.photos_for(id, {optional: 'query_params_hash'})
+```
+
+### Channels
+
+API channel endpoints can be accessed through the `Littlstar::Channels` class.
+
+```ruby
+ls_channels = Littlstar::Channels.new
+
+# Get a single channel
+ls_channels.get(id)
+
+# Get all channels
+ls_channels.all({optional: 'query_params_hash'})
+
+# Get single channel videos
+ls_channels.videos_for(id, {optional: 'query_params_hash'})
+
+# Get single channel photos
+ls_channels.photos_for(id, {optional: 'query_params_hash'})
+```
+
+### Hashtags
+
+API hashtag endpoints can be accessed through the `Littlstar::Hashtags` class.
+
+```ruby
+ls_hashtags = Littlstar::Hashtags.new
+
+# Get a single hashtag
+ls_hashtags.get(id)
+
+# Get all hashtags
+ls_hashtags.all({optional: 'query_params_hash'})
+
+# Get single hashtag videos
+ls_hashtags.videos_for(id, {optional: 'query_params_hash'})
+
+# Get single hashtag photos
+ls_hashtags.photos_for(id, {optional: 'query_params_hash'})
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/littlstar/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,17 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+desc 'Generate gem documentation'
+task :doc do
+  system 'rm -rf doc/'
+  system 'rdoc --exclude=/spec/'
+end
+
+namespace :minitest do
+  Rake::TestTask.new(:all) do |t|
+    t.libs << 'test'
+    t.test_files = FileList['test/test_*.rb']
+  end
+end
+
+task :default => 'minitest:all'

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "littlstar"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/littlstar.rb

@@ -0,0 +1,64 @@
+# Littlstar Ruby Library
+require 'net/http'
+require 'json'
+require 'littlstar/version'
+require 'littlstar/search'
+require 'littlstar/users'
+require 'littlstar/videos'
+require 'littlstar/photos'
+require 'littlstar/categories'
+require 'littlstar/channels'
+require 'littlstar/hashtags'
+
+module Littlstar
+
+  @@apikey   = ''
+  @@api_base = 'https://littlstar.com/api/v1'
+
+  def self.apikey()
+    @@apikey
+  end
+
+  def self.apikey=(key)
+    @@apikey = key
+  end
+
+  def self.api_base()
+    @@api_base
+  end
+
+  def self.api_base=(base)
+    @@api_base = base
+  end
+
+  def self.api_url(path='', query={})
+    self.api_base + path + self.query_params_from(query)
+  end
+
+  def self.query_params_from(hash)
+    "?#{URI.encode(hash.map { |k,v| "#{k}=#{v}" }.join('&'))}"
+  end
+
+  ##
+  # The request() method is the heart and soul of the library. It is responsible for taking the
+  # connection details from each resource class and creating the Net::HTTP object that will
+  # ultimately send the appropriate request and return the response from the Littstar API server.
+  def self.request(method, path, query={})
+
+    # create connection uri
+    uri  = URI.parse(self.api_url(path, query))
+
+    # create request object
+    req = Net::HTTP::Get.new(uri.to_s)
+    req['User-Agent']   = "ruby-sdk/#{Littlstar::VERSION}",
+    req['Content-Type'] = 'application/json',
+    req['X-Apikey']     = self.apikey
+
+    # send request and build response
+    Net::HTTP.start(uri.host, uri.port, use_ssl: true)  do |http|
+      res = http.request(req)
+      JSON.parse(res.body, symbolize_names: true)
+    end
+
+  end
+end

data/lib/littlstar/categories.rb

@@ -0,0 +1,21 @@
+module Littlstar
+  class Categories
+
+    def get(id)
+      Littlstar.request(:get, "/categories/#{id}")
+    end
+
+    def all(query={})
+      Littlstar.request(:get, '/categories', query)
+    end
+
+    def videos_for(id, query={})
+      Littlstar.request(:get, "/categories/#{id}/videos", query)
+    end
+
+    def photos_for(id, query={})
+      Littlstar.request(:get, "/categories/#{id}/photos", query)
+    end
+
+  end
+end

data/lib/littlstar/channels.rb

@@ -0,0 +1,21 @@
+module Littlstar
+  class Channels
+
+    def get(id)
+      Littlstar.request(:get, "/channels/#{id}")
+    end
+
+    def all(query={})
+      Littlstar.request(:get, '/channels', query)
+    end
+
+    def videos_for(id, query={})
+      Littlstar.request(:get, "/channels/#{id}/videos", query)
+    end
+
+    def photos_for(id, query={})
+      Littlstar.request(:get, "/channels/#{id}/photos", query)
+    end
+
+  end
+end

data/lib/littlstar/hashtags.rb

@@ -0,0 +1,21 @@
+module Littlstar
+  class Hashtags
+
+    def get(id)
+      Littlstar.request(:get, "/hashtags/#{id}")
+    end
+
+    def all(query={})
+      Littlstar.request(:get, '/hashtags', query)
+    end
+
+    def videos_for(id, query={})
+      Littlstar.request(:get, "/hashtags/#{id}/videos", query)
+    end
+
+    def photos_for(id, query={})
+      Littlstar.request(:get, "/hashtags/#{id}/photos", query)
+    end
+
+  end
+end

data/lib/littlstar/photos.rb

@@ -0,0 +1,29 @@
+module Littlstar
+  class Photos
+
+    def get(id)
+      Littlstar.request(:get, "/photos/#{id}")
+    end
+
+    def all(query={})
+      Littlstar.request(:get, '/photos', query)
+    end
+
+    def featured(query={})
+      Littlstar.request(:get, '/photos/featured', query)
+    end
+
+    def latest(query={})
+      Littlstar.request(:get, '/photos/latest', query)
+    end
+
+    def vr(query={})
+      Littlstar.request(:get, '/photos/vr', query)
+    end
+
+    def comments_for(id, query={})
+      Littlstar.request(:get, "/photos/#{id}/comments", query)
+    end
+
+  end
+end

data/lib/littlstar/search.rb

@@ -0,0 +1,25 @@
+module Littlstar
+  class Search
+
+    def all(query={})
+      Littlstar.request(:get, '/search', query)
+    end
+
+    def videos(query={})
+      Littlstar.request(:get, '/search/videos', query)
+    end
+
+    def photos(query={})
+      Littlstar.request(:get, '/search/photos', query)
+    end
+
+    def users(query={})
+      Littlstar.request(:get, '/search/users', query)
+    end
+
+    def channels(query={})
+      Littlstar.request(:get, '/search/channels', query)
+    end
+
+  end
+end

data/lib/littlstar/users.rb

@@ -0,0 +1,29 @@
+module Littlstar
+  class Users
+
+    def get(id)
+      Littlstar.request(:get, "/users/#{id}")
+    end
+
+    def videos_for(id, query={})
+      Littlstar.request(:get, "/users/#{id}/videos", query)
+    end
+
+    def photos_for(id, query={})
+      Littlstar.request(:get, "/users/#{id}/photos", query)
+    end
+
+    def channels_for(id, query={})
+      Littlstar.request(:get, "/users/#{id}/channels", query)
+    end
+
+    def followers_for(id, query={})
+      Littlstar.request(:get, "/users/#{id}/followers", query)
+    end
+
+    def following_for(id, query={})
+      Littlstar.request(:get, "/users/#{id}/following", query)
+    end
+
+  end
+end

data/lib/littlstar/version.rb

@@ -0,0 +1,3 @@
+module Littlstar
+  VERSION = '0.1.2'
+end

data/lib/littlstar/videos.rb

@@ -0,0 +1,33 @@
+module Littlstar
+  class Videos
+
+    def get(id)
+      Littlstar.request(:get, "/videos/#{id}")
+    end
+
+    def all(query={})
+      Littlstar.request(:get, '/videos', query)
+    end
+
+    def sponsored(query={})
+      Littlstar.request(:get, '/videos/sponsored', query)
+    end
+
+    def featured(query={})
+      Littlstar.request(:get, '/videos/featured', query)
+    end
+
+    def latest(query={})
+      Littlstar.request(:get, '/videos/latest', query)
+    end
+
+    def vr(query={})
+      Littlstar.request(:get, '/videos/vr', query)
+    end
+
+    def comments_for(id, query={})
+      Littlstar.request(:get, "/videos/#{id}/comments", query)
+    end
+
+  end
+end

data/littlstar.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'littlstar/version'
+
+Gem::Specification.new do |spec|
+  spec.name    = 'littlstar'
+  spec.version = Littlstar::VERSION
+  spec.authors = ['Dominic Giglio']
+  spec.email   = ['support@littlstar.com']
+
+  spec.summary     = %q{Access Littlstar API}
+  spec.description = %q{This gem defines methods for controlling your content through the Littlstar API.}
+  spec.homepage    = 'https://github.com/littlstar/ruby-sdk'
+  spec.license     = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.9'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: littlstar
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Dominic Giglio
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-07-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: This gem defines methods for controlling your content through the Littlstar
+  API.
+email:
+- support@littlstar.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/littlstar.rb
+- lib/littlstar/categories.rb
+- lib/littlstar/channels.rb
+- lib/littlstar/hashtags.rb
+- lib/littlstar/photos.rb
+- lib/littlstar/search.rb
+- lib/littlstar/users.rb
+- lib/littlstar/version.rb
+- lib/littlstar/videos.rb
+- littlstar.gemspec
+homepage: https://github.com/littlstar/ruby-sdk
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Access Littlstar API
+test_files: []