vinery 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 63d4bddfaed7dee2966e0b13304ee9744ea35d37
+  data.tar.gz: 02fd83fdd59a6bdca36ed5b36e65a36368641e1b
+SHA512:
+  metadata.gz: 36e734bd48ce8528616e66b6c93629cf653946e0f6332b0740aa6593e885cb971790a19ff8c2e6eecb7535350bc75b3ba1178bf14473fa9a6fc36a10ecf5acea
+  data.tar.gz: 833eb18d671fbe27b4af62417ec27d935f2eca533ef758eafb41ca4affbdec0ba7cc5fc9ba7114415479472de4254e359a43c9cf19e4a30e8481cbffae29912a

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.env

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Jake Bellacera
+
+MIT License
+
+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,46 @@
+# Vinery
+
+A Ruby interface for [Vine](http://vine.co).
+
+***
+
+**NOTE:** Vinery currently only has one API method at the moment: `tagged`. This interface is very incomplete right now, so please contribute!
+
+***
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'vinery'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install vinery
+
+## Usage
+
+Vine's API requires _all_ requests to be authenticated (via a session cookie) with a valid Vine username and password. Vinery will authenticate you upon initialization.
+
+To begin, `require` Vinery in your ruby script and then create a new instance of `Vinery::API` by passing your Vine username and password as parameters.
+
+```ruby
+require 'vinery'
+vinery = Vinery::API.new(vine_username,vine_password)
+```
+
+If Vine rejects your credentials, Vinery will raise `InvalidCredentialsError`. If no errors occur, then you have successfully authenticated with Vine and you're ready to go!
+
+To learn more about how to work with `Vinery::API`, [browse the source code](lib/vinery/api.rb).
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << "lib"
+  t.libs << "test"
+  t.pattern = "test/*_test.rb"
+end

data/lib/vinery.rb

@@ -0,0 +1,5 @@
+require "json"
+require "vinery/version"
+require "vinery/record"
+require "vinery/collection"
+require "vinery/api"

data/lib/vinery/api.rb

@@ -0,0 +1,115 @@
+require "httparty"
+require "vinery/errors/invalid_credentials"
+
+module Vinery
+  # Public: The unofficial interface for the Vine API. Vine requires all
+  # requests to be authenticated when accessing the API.
+  # 
+  # Examples
+  #   
+  #   vinery = Vinery::API.new("username", "password")
+  #   funny_vines = vinery.tagged("funny")
+  class API
+    include HTTParty
+    base_uri "https://api.vineapp.com"
+
+    # Public: Initializes a new Vine API instance.
+    # 
+    # username - The String Vine username.
+    # password - The String Vine password.
+    # 
+    # Examples
+    #   
+    #   vinery = Vinery::API.new("username", "password")
+    # 
+    # Returns the new Vine instance.
+    def initialize(username, password)
+      login(username, password)
+    end
+
+    # Public: fetches a list of Vines that are tagged with a certain tag.
+    # 
+    # tag   - The String tag to search for.
+    # query - The Hash options used to refine the selection (default: {}).
+    #         :page - The Integer page number to paginate results (default: 1).
+    #         :size - The Integer number of results to display (default: 20).
+    # 
+    # Examples
+    #   
+    #   vinery.tagged("funny")
+    #   
+    #   vinery.tagged("funny", { page: 2, size: 10 })
+    # 
+    # Returns a Hash of Vines.
+    def tagged(tag, query = {})
+      query = {
+        page: 1,
+        size: 20 
+      }.merge!(query)
+
+      Collection.new(get_parsed("/timelines/tags/#{tag}", query)["records"].map { |r| Record.new(r) })
+    end
+
+    private
+
+    # Private: authenticates a Vine user with the Vine API. This method only needs
+    # to be ran once per Vine instance.
+    # 
+    # username - The String Vine username.
+    # password - The String Vine password.
+    # 
+    # Returns nothing.
+    def login(username, password)
+      response = self.class.post("/users/authenticate", {
+        body: {
+          username: username,
+          password: password
+        }
+      })
+
+      body = parse_json(response.body)
+
+      raise Vinery::InvalidCredentialsError unless body["success"]
+
+      @auth = {
+        user_id: body["data"]["userId"],
+        key: body["data"]["key"]
+      }
+    end
+
+    # Private: performs an HTTP GET request with required headers.
+    # 
+    # url     - The String URL that we would GET. The URL should be relative to the
+    #           Vine API's domain.
+    # query   - The Hash of query key/value pairs (default: {}).
+    # headers - The Hash of additional HTTP request headers (default: {}).
+    #
+    # Returns an instance of HTTParty::Response.
+    def get(url, query = {}, headers = {})
+      headers.merge!({
+        "User-Agent" => "com.vine.iphone/1.0.3 (unknown, iPhone OS 6.0.1, iPhone, Scale/2.000000)",
+        "Accept-Language" => "en, sv, fr, de, ja, nl, it, es, pt, pt-PT, da, fi, nb, ko, zh-Hans, zh-Hant, ru, pl, tr, uk, ar, hr, cs, el, he, ro, sk, th, id, ms, en-GB, ca, hu, vi, en-us;q=0.8",
+        "vine-session-id" => @auth[:key]
+      })
+
+      self.class.get(url, { query: query, headers: headers })
+    end
+
+    # Private: perfoms the get method and parses the response.
+    # 
+    # Returns a Hash of the HTTP GET response body.
+    def get_parsed(*get_args)
+      response = send(:get, *get_args)
+      parse_json(response.body)["data"]
+    end
+
+    # Private: parses a JSON String.
+    # 
+    # string - The String of JSON.
+    # 
+    # Returns a the parsed JSON as a Hash.
+    def parse_json(string)
+      JSON.parse(string)
+    end
+  end
+end

data/lib/vinery/collection.rb

@@ -0,0 +1,30 @@
+module Vinery
+  # Public: An array-like object that contains Records. This class inherits from
+  # Array.
+  # 
+  # Examples
+  #   
+  #   collection = Collection.new
+  #   
+  #   collection.add(record1)
+  #   
+  #   collection << record2
+  #   
+  #   collection = Collection.new([record1, record2, record3])
+  class Collection < Array
+    # Public: Appends a new Record to the end of a Collection.
+    # 
+    # record - The Record to be appended to the end of the Collection.
+    # 
+    # Examples
+    #   
+    #   collection.push(record)
+    # 
+    # Returns the array of Records.
+    def add(record)
+      raise TypeError, "the object you're tyring to add is not a Record" unless record.is_a? Record
+      super(record)
+    end
+    alias_method :<<, :add
+  end
+end

data/lib/vinery/errors/invalid_credentials.rb

@@ -0,0 +1,3 @@
+module Vinery
+  class InvalidCredentialsError < StandardError; end
+end

data/lib/vinery/record.rb

@@ -0,0 +1,86 @@
+module Vinery
+  # Public: A Vine post. Contains attributes and helper methods for working with
+  # a specific post.
+  class Record
+    attr_reader :description, :id, :raw, :share_url, :thumbnail_url, :user_id, :venue, :video_url
+
+    # Public: Initializes a new Record instance.
+    # 
+    # data - A Hash that contains the posting's attributes. Typically this is
+    #        a record from a parsed JSON response.
+    # 
+    # Returns the new Vine instance.
+    def initialize(data)
+      @description = data["description"]
+      @id = data["postId"]
+      @raw = data
+      @share_url = data["shareUrl"]
+      @thumbnail_url = data["thumbnailUrl"]
+      @user_id = data["userId"]
+      @venue = data["venue_name"]
+      @video_url = data["videoUrl"]
+    end
+
+    # Public: Converts the Record into a Hash.
+    # 
+    # Returns the String representation of the Record.
+    def to_h
+      h = {}
+      instance_variables.map { |iv| iv.to_s.gsub(/^@/, "") }.each do |attribute|
+        h[attribute] = send(attribute)
+      end
+      h
+    end
+
+    # Public: Converts the Record into JSON.
+    # 
+    # Returns the String raw JSON data of the record.
+    def to_json(*a)
+      to_h.to_json(*a)
+    end
+
+    # Public: Produces a human-readable representation of the Record.
+    # 
+    # Returns the String representation of the Record.
+    def inspect
+      "<#{self.class} @id=\"#{@id}\" @video_url=\"#{@video_url}\" @description=\"#{@description}\">"
+    end
+
+    # Public: Produces a HTML iframe embed tag.
+    # 
+    # type       - A Symbol that specifies the type of embed layout to display.
+    #              Possible types are :simple and :postcard (default: :simple).
+    #              If the type is not allowed, it will revert to :simple.
+    # html_attrs - A Hash of HTML attributes for the iframe tag (default: {}).
+    #              Any keys with an underscore ("_") will be replaced with a 
+    #              hyphen ("-").
+    # 
+    # Examples
+    #   
+    #   record.embed_tag
+    #   # => '<iframe src=".../embed/simple"></iframe>'
+    #   
+    #   record.embed_tag(:postcard)
+    #   # => '<iframe src=".../embed/postcard"></iframe>'
+    #   
+    #   record.embed_tag(:simple, {
+    #     width: 600,
+    #     height: 600,
+    #     id: "vine-video",
+    #     class: "class1 class2",
+    #     data_foo: "bar"
+    #   })
+    #   # => '<iframe src="..." width="600" height="600" id="vine-video"
+    #        class="class1 class2" data-foo="bar"></iframe>'
+    def embed_tag(type = :simple, html_attrs = {})
+      allowed_types = [:simple, :postcard]
+      type = :simple unless allowed_types.include?(type)
+      attrs = ""
+      html_attrs = attrs.each do |attr, val|
+        attrs << " #{attr.to_s.replace('_', '-')}=\"#{val}\""
+      end
+
+      "<iframe src=\"#{@share_url}/embed/#{type}\"#{attrs}></iframe>"
+    end
+  end
+end

data/lib/vinery/version.rb

@@ -0,0 +1,3 @@
+module Vinery
+  VERSION = "0.0.1"
+end

data/test/api_test.rb

@@ -0,0 +1,14 @@
+require "test_helper"
+
+class ApiTest < MiniTest::Unit::TestCase
+  def test_invalid_login
+    assert_raises Vinery::InvalidCredentialsError do
+      Vinery::API.new("", "")
+    end
+  end
+
+  def test_tagged
+    vine = Vinery::API.new(ENV["VINE_USERNAME"], ENV["VINE_PASSWORD"])
+    refute_nil vine.tagged("funny") # TODO: make this better
+  end
+end

data/test/collections_test.rb

@@ -0,0 +1,10 @@
+require "test_helper"
+
+class CollectionsTest < MiniTest::Unit::TestCase
+  def test_to_json
+    vinery = Vinery::API.new(ENV["VINE_USERNAME"], ENV["VINE_PASSWORD"])
+    records = vinery.tagged("funny")
+    records_json = records.to_json
+    assert_equal records[0].thumbnail_url, JSON.parse(records_json)[0]["thumbnail_url"]
+  end
+end

data/test/record_test.rb

@@ -0,0 +1,29 @@
+require "test_helper"
+
+class RecordTest < MiniTest::Unit::TestCase
+  def setup
+    @vinery = Vinery::API.new(ENV["VINE_USERNAME"], ENV["VINE_PASSWORD"])
+    @record = @vinery.tagged("funny").first
+  end
+
+  def test_to_h
+    record_hash = @record.to_h
+    record_attributes.each do |attribute|
+      assert_equal @record.send(attribute), record_hash[attribute]
+    end
+  end
+
+  def test_to_json
+    record_json = JSON.parse(@record.to_json)
+    
+    record_attributes.each do |attribute|
+      assert_equal @record.send(attribute), record_json[attribute]
+    end
+  end
+
+  private
+
+  def record_attributes
+    @record.instance_variables.map { |iv| iv.to_s.gsub(/^@/, "") }
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+require "dotenv"
+
+Dotenv.load
+
+require "vinery"
+require "minitest/autorun"

data/vinery.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vinery/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "vinery"
+  spec.version       = Vinery::VERSION
+  spec.authors       = ["Jake Bellacera"]
+  spec.email         = ["jakeb@eleveninc.com"]
+  spec.description   = "A Ruby interface for Vine."
+  spec.summary       = "A Ruby interface for Vine."
+  spec.homepage      = "http://github.com/jakebellacera/vinery"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "httparty", "0.12.0"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "dotenv", "0.9.0"
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: vinery
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jake Bellacera
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+description: A Ruby interface for Vine.
+email:
+- jakeb@eleveninc.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/vinery.rb
+- lib/vinery/api.rb
+- lib/vinery/collection.rb
+- lib/vinery/errors/invalid_credentials.rb
+- lib/vinery/record.rb
+- lib/vinery/version.rb
+- test/api_test.rb
+- test/collections_test.rb
+- test/record_test.rb
+- test/test_helper.rb
+- vinery.gemspec
+homepage: http://github.com/jakebellacera/vinery
+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.0.3
+signing_key: 
+specification_version: 4
+summary: A Ruby interface for Vine.
+test_files:
+- test/api_test.rb
+- test/collections_test.rb
+- test/record_test.rb
+- test/test_helper.rb