twenty20 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aad59c3f8645620c5b0390527f4cadeebfa0a21a
+  data.tar.gz: d8e020a810e145f5228240c68c39ded8f3463842
+SHA512:
+  metadata.gz: 16ff75c3315438401164caef578eb839d79674e134e74a62b09c1c1da7f1bf363964aafe4148e304dc666c72a11f3993a88f9d368c6ff4298d38971fdec4262f
+  data.tar.gz: a90218f44099818327fdce709da9c035497aec1bc270db9b3e4a9bc844f01127a5e227d0e9a3c777c552407202a1a1963e388d377228fd13111bdb3a46f3d7e5

data/Gemfile

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

data/README.md

@@ -0,0 +1,49 @@
+# Twenty20
+Api client for interacting with Twenty20's internal API.  Still in development
+
+Example uses
+  - query featured items
+  - query items you have 'loved'
+  - query challenges
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'twenty20'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install twenty20
+
+## Usage
+
+API client for interacting with Twenty20s internal API.
+
+Instantiate a new client
+
+```ruby
+  client = Twenty20::Client.new
+```
+Get Featured items
+  
+```ruby
+  client.get_featured_items()
+```
+```ruby
+  [#<Item:0x007feff9212348 @caption="Red Canoes on Lake Louise", @id=45414069, @source_name="upload", @image_url="https://res.cloudinary.com/twenty20/image/upload/t_standard-fit/photos/cf34293d-1eeb-47a7-94c7-99397dce4c15.jpg", @featured_at="2014-11-29T22:40:04Z", @user_first_name=nil, @user_last_name=nil, @user_avatar_url=nil, @username=nil, @display_name=nil>, #<Item:0x007feff9212190 @caption=nil, @id=49291337, @source_name="instagram", @image_url="http://scontent-b.cdninstagram.com/hphotos-xpa1/t51.2885-15/1742594_280292302171814_502487005_n.jpg", @featured_at="2014-11-29T22:20:02Z"...]
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/AlexWheeler/twenty20_API/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,3 @@
+require "bundler/gem_tasks"
+Dir.glob('tasks/**/*.rake').each(&method(:import))
+

data/lib/twenty20.rb

@@ -0,0 +1,51 @@
+require "twenty20/version"
+require "twenty20/item"
+require "twenty20/challenge"
+require "httparty"
+
+module Twenty20
+  class Client 
+    include HTTParty
+    BASE_URI = "https://api-v2.twenty20.com/"
+    
+    def get_featured_items
+      featured_route = "items/featured"
+      featured_params = "?featured=true"
+      resource = build_route(featured_route, featured_params) 
+      response = self.class.get(resource)
+      if(response.code == 200)
+        item_collection = to_item_collection(response)
+        item_collection
+      else
+        "Error"
+      end
+    end
+
+    def get_challenges
+      challenges_route = "/challenges/open-for-submissions"
+      resource = build_route(challenges_route)
+      response = self.class.get(resource) 
+      if(response.code == 200)
+        challenge_collection = to_challenge_collection(response)
+        challenge_collection
+      else
+        "Error"
+      end
+    end
+
+    private
+
+    def to_item_collection(response)  #creates Item objects out of each element in the response object and returns this new array
+      response.parsed_response["items"].collect {|item| Item.new(item)}
+    end
+
+    def to_challenge_collection(response)
+      response.parsed_response["challenges"].collect {|challenge| Challenge.new(challenge)}
+    end
+
+    def build_route(uri, params = "")
+      route = BASE_URI + uri + params
+      route
+    end
+  end
+end

data/lib/twenty20/challenge.rb

@@ -0,0 +1,14 @@
+module Twenty20
+  class Challenge
+    attr_reader :slug, :name, :description, :starts_at, :ends_at, :submission_count
+    
+    def initialize(attributes = {})
+      @slug = attributes["slug"] 
+      @name = attributes["name"]
+      @description = attributes["description"]
+      @starts_at = attributes["starts_at"]
+      @ends_at = attributes["ends_at"]
+      @submission_count = attributes["submission_count"]
+    end
+  end
+end

data/lib/twenty20/item.rb

@@ -0,0 +1,19 @@
+module Twenty20
+  class Item
+    attr_reader :caption, :id, :source_name, :image_url, :featured_at, :user_first_name, 
+                  :user_last_name, :user_avatar_url, :username, :display_name
+    def initialize(attributes = {})     #set default so attributes will default to nil and not throw exception if not present
+      @caption = attributes["caption"]
+      @id = attributes["id"]
+      @source_name = attributes["source_name"]
+      @image_url = attributes["standard_url"]
+      @featured_at = attributes["featured_at"]
+      @user_first_name = attributes["first_name"]
+      @user_last_name = attributes["last_name"]
+      @user_avatar_url = attributes["avatar"]
+      @username = attributes["username"]
+      @display_name = attributes["display_name"]
+    end
+  end
+end
+

data/lib/twenty20/version.rb

@@ -0,0 +1,3 @@
+module Twenty20
+  VERSION = "0.0.2"
+end

data/spec/challenge_spec.rb

@@ -0,0 +1,35 @@
+require "spec_helper"
+
+describe Twenty20::Challenge do
+  describe "slug" do
+    
+    before(:all) do
+      attributes = {"slug" => "technology-challenge"}
+      @challenge = Twenty20::Challenge.new(attributes)
+    end
+    
+    it "returns the slug for the challenge" do
+      expect(@challenge.slug).to eq("technology-challenge")
+    end
+
+    it "should be immutable" do
+      expect{@challenge.slug = "some new slug"}.to raise_error(NoMethodError)   
+    end
+  end
+
+  describe "name" do
+    it "returns the name of the challenge" do
+      attributes = {"name" => "technology"}
+      challenge = Twenty20::Challenge.new(attributes)
+      expect(challenge.name).to eq("technology")
+    end
+  end
+
+  describe "description" do
+    it "returns the description of the challenge" do
+      attributes = {"description" => "really cool challenge"}
+      challenge = Twenty20::Challenge.new(attributes)
+      expect(challenge.description).to eq("really cool challenge")
+    end
+  end
+end

data/spec/client_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe Twenty20::Client do
+
+  describe "BASE_URI" do
+    it "returns the base uri for the api" do
+      expect(Twenty20::Client::BASE_URI).to eq("https://api-v2.twenty20.com/")
+    end
+  end
+
+  describe "get_featured_items" do
+
+    before(:all) do
+      @client = Twenty20::Client.new
+    end
+
+    it "returns an Array" do
+      expect(@client.get_featured_items.class).to eq(Array)
+    end
+
+    it "returns an Array of Item objects" do
+      expect(@client.get_featured_items[0].class).to eq(Twenty20::Item)
+    end
+
+    it "returns error if status is not 200" do
+      fake_response = double
+      fake_response.stub(:code) { 400 }
+      Twenty20::Client.stub(:get)  { fake_response }
+      response = @client.get_featured_items
+      expect(response).to eq("Error")
+    end
+
+    it "doesnt return error if status is 200" do
+    end
+  end
+
+  describe "get_challenges" do
+    before(:all) do
+      @client = Twenty20::Client.new
+    end
+
+    it "should return an array of challenge objects" do
+      response = @client.get_challenges
+      expect(response.class).to eq(Array);
+    end
+  end
+end

data/spec/item_spec.rb

@@ -0,0 +1,47 @@
+require "spec_helper"
+
+describe Twenty20::Item do
+  describe "category" do
+    it "returns the items category" do
+      attributes = {"caption" => "mobile photography ftw"}
+      item = Twenty20::Item.new(attributes)
+      expect(item.caption).to eq("mobile photography ftw")
+    end
+
+    it "returns nil when not present" do
+      item = Twenty20::Item.new
+      expect(item.caption).to eq(nil)
+    end
+
+    it "should be immutable" do
+      item = Twenty20::Item.new
+      expect{item.category = "not allowed"}.to raise_error(NoMethodError) 
+    end
+  end
+ 
+  describe "id" do
+    it "returns the items id " do
+      attributes = {"id" => 1}
+      item = Twenty20::Item.new(attributes)
+      expect(item.id).to eq(1)
+    end
+
+    it "returns nil when not present" do
+      item = Twenty20::Item.new
+      expect(item.id).to eq(nil)
+    end
+  end 
+ 
+  describe "source_name" do
+    it "returns the items id " do
+      attributes = {"source_name" => "Instagram"}
+      item = Twenty20::Item.new(attributes)
+      expect(item.source_name).to eq("Instagram")
+    end
+
+    it "returns nil when not present" do
+      item = Twenty20::Item.new
+      expect(item.source_name).to eq(nil)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'twenty20'

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: twenty20
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Alex Wheeler
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+description: API client to explore Twenty20
+email:
+- afwheeler92@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- Rakefile
+- lib/twenty20.rb
+- lib/twenty20/challenge.rb
+- lib/twenty20/item.rb
+- lib/twenty20/version.rb
+- spec/challenge_spec.rb
+- spec/client_spec.rb
+- spec/item_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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: explore twenty20
+test_files:
+- spec/challenge_spec.rb
+- spec/client_spec.rb
+- spec/item_spec.rb
+- spec/spec_helper.rb