storify 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 054fc92b925bfaa5fe6f12055fb3edad0fc9edcf
+  data.tar.gz: 6c797051ce7a0808ee903c1df1ba6589c2789581
+SHA512:
+  metadata.gz: 305a38acf3661181cc9ef7884d4b4a38f6fdd44b16a76835f5f1fe838ccb85d08138795191c08111be064512b69777d871bb695c3079ee9929347f752634db51
+  data.tar.gz: 0f16afc75eb29e7b1cf3f9e01e76b676d79393d67c47dd4d5d5db80a732b65017a8f8687e981d7cc3c9f8cb58ac4c8932ce96e3de8b6c9700eab4c54810690e9

data/lib/storify/apierror.rb

@@ -0,0 +1,13 @@
+class Storify::ApiError < StandardError
+  attr_reader :status, :type, :message
+
+  def initialize(status, message, type = nil)
+    @type = type
+    @status = status
+    @message = message
+  end
+
+  def to_s
+    "#{self.status} #{self.type} #{self.message}"
+  end
+end

data/lib/storify/client.rb

@@ -0,0 +1,67 @@
+require 'json'
+require 'rest-client'
+#RestClient.log = './restclient.log'    
+
+class Storify::Client
+  attr_reader :api_key, :username, :token, :raw
+
+  def initialize(api_key, username)
+    @api_key = api_key
+    @username = username
+  end
+
+  def auth(password)
+    endpoint = Storify::auth
+    data = call(endpoint, :POST, {password: password})
+    @token = data['content']['_token']
+
+    self
+  end
+
+  def stories(slug: nil, world: false)
+    # filter from general to specific
+    endpoint = Storify::stories if world
+    endpoint = Storify::userstories(@username) unless world
+    endpoint = Storify::story(@username, slug) unless slug.nil?
+    call(endpoint, :GET)
+
+    self
+  end
+
+  def authenticated
+    !@token.nil?
+  end
+
+  def deserialize
+    JSON.parse(@raw)
+  end
+
+
+  private 
+  
+  def call(endpoint, verb, params = {}, opts = {})
+    @raw = nil
+
+    begin
+      # inject auth params automatically (if available)
+      params[:username] = @username
+      params[:api_key] = @api_key
+      params[:_token] = @token if authenticated
+
+      case verb
+      when :POST
+        @raw = RestClient.post endpoint, params, {:accept => :json}
+      else
+        @raw = RestClient.get endpoint, {:params => params}
+      end
+    rescue => e
+      @raw = e.response
+      
+      data = JSON.parse(e.response)
+      error = data['error']
+      raise Storify::ApiError.new(data['code'], error['message'], error['type']) 
+    end
+
+    deserialize
+  end
+end

data/lib/storify.rb

@@ -0,0 +1,30 @@
+module Storify
+  BASE_URL = 'https://api.storify.com'
+
+  def self.api(secure = true)
+    (secure ? 'https' : 'http') + '://api.storify.com'
+  end
+
+  def self.versioned_api(secure: true, version: 1)
+    api(secure) << "/v#{version}"
+  end
+
+  def self.auth
+    versioned_api << "/auth"
+  end
+
+  def self.stories
+    versioned_api << "/stories"
+  end
+
+  def self.userstories(username)
+    stories << "/#{username}"
+  end
+
+  def self.story(username, slug)
+    userstories(username) << "/#{slug}"
+  end
+end
+
+require 'storify/client'
+require 'storify/apierror'

data/spec/client_auth_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe "Storify::Client -- Authentication" do
+  before(:each) do
+    @client = Storify::Client.new(@api_key, @username)
+  end
+
+  it "should retrieve an auth token on success" do
+
+    @client.auth(get_password).token.should_not be_nil
+    @client.authenticated.should be_true
+  end
+
+  it "should raise an API error on failure" do
+    expect{@client.auth('invalid_password')}.to raise_error(Storify::ApiError)
+  end
+end

data/spec/client_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe Storify::Client do
+  before(:all) do
+    @client = Storify::Client.new(@api_key, @username)
+    @client.auth(get_password)
+  end
+
+  it "should get the first page of a users stories" do
+    @client.stories(:world => false).deserialize.should_not be_nil
+  end
+
+  it "should get a specific "
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+require 'storify'
+require 'io/console'
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+  config.add_setting :api_key, :default => ''
+  config.add_setting :api_usr, :default => ''
+  
+  # load user-specific keys or fallback to defaults
+  config.before(:all) do
+    begin
+      require File.dirname(__FILE__) + '/.userkey.rb'
+      @api_key = API_KEY
+      @username = USERNAME
+    rescue LoadError
+      @api_key = RSpec.configuration.api_key
+      @username = RSpec.configuration.api_usr
+    end
+
+  end
+end
+
+def get_password
+  puts "Enter Storify Password:"
+  STDOUT.flush
+  STDIN.noecho(&:gets).chomp
+end

data/spec/storify_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe Storify do
+  it "should default to un-versioned https API access" do
+    Storify::api.should eq 'https://api.storify.com'
+  end
+
+  it "should allow explicit un-versioned https or http for API access" do
+    Storify::api(false).should eq 'http://api.storify.com'
+    Storify::api(true).should eq 'https://api.storify.com'
+  end
+
+  it "should allow dynamic versioned http or https API access" do
+    Storify::versioned_api.should eq 'https://api.storify.com/v1'
+    Storify::versioned_api(:version => 2).should eq 'https://api.storify.com/v2'
+
+    Storify::versioned_api(:secure => false, 
+                           :version => 2).should eq 'http://api.storify.com/v2'
+  end
+
+  it "should retrieve the auth API endpoint" do
+    Storify::auth.should eq 'https://api.storify.com/v1/auth'
+  end
+
+  it "should retrieve the stories API endpoint" do
+    Storify::stories.should eq 'https://api.storify.com/v1/stories'
+  end
+
+  it "should retrieve the user-specific stories API endpoint" do
+    Storify::userstories(@username).should eq "https://api.storify.com/v1/stories/#{@username}"
+  end
+
+  it "should retrieve a user-specific story API endpoint" do
+    Storify::story(@username, "mystory").should eq "https://api.storify.com/v1/stories/#{@username}/mystory"
+  end
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: storify
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- Rizwan Tejpar
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.6.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.6.7
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.7.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.7.7
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+description: Ruby Wrapper of Storify REST API -- work-in-progress
+email: rtejpar@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/storify/apierror.rb
+- lib/storify/client.rb
+- lib/storify.rb
+- spec/client_auth_spec.rb
+- spec/client_spec.rb
+- spec/spec_helper.rb
+- spec/storify_spec.rb
+homepage: https://github.com/natural-affinity/storify
+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.1.11
+signing_key: 
+specification_version: 4
+summary: Storify API
+test_files:
+- spec/client_auth_spec.rb
+- spec/client_spec.rb
+- spec/spec_helper.rb
+- spec/storify_spec.rb