github-api 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in github-oauth.gemspec
+gemspec

data/README.md

@@ -0,0 +1,50 @@
+Installation
+------------
+
+NB: This is a super early version of this gem. Use only for testing purposes
+
+To install the gem, simply run:
+
+    gem install 'github-api'
+
+Or the bundler equivalent:
+
+    bundle install 'github-api'
+
+Examples
+--------
+
+Use the gem to create / retrieve Github repo data. You can use my 'github-oauth' gem to get the token.
+
+Use oauth token to create a user object
+
+    @user = GithubApi::User.new(ab3cd9j4ks73hf7)
+
+Then create stuff
+    
+    @user.has_repo?("my_repo_name")
+
+    repo = @user.create_repo("githunch_bookmarks", {
+      :description => "Repository for Githunch Bookmarks",
+      :homepage => "http://githunch.heroku.com",
+      :public => true,
+      :has_issues => false,
+      :has_wiki => false,
+      :has_downloads => false
+    })
+
+    file = GithubApi::Blob.new(:content => "this is my content", :path => "bookmarks.json")
+    tree = repo.create_tree([file])
+
+    commit = repo.create_initial_commit(tree.data["sha"], "This is my commit text")
+
+    reference = repo.create_ref("refs/heads/master", commit.data["sha"])
+
+Or retrieve stuff
+
+    blob = repo.ref("heads/master").commit.tree.file("bookmarks.json")
+    puts blob.content
+
+   
+
+   

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/github-api.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "github-api"
+  s.version     = "0.0.1"
+  s.authors     = ["Rune Madsen"]
+  s.email       = ["rune@runemadsen.com"]
+  s.homepage    = ""
+  s.summary     = %q{A simple gem to simplify requests to the Github API}
+  s.description = %q{A simple gem to simplify requests to the Github API}
+
+  s.rubyforge_project = "github-api"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "json"
+  s.add_development_dependency "rspec", "~> 2.6"
+  s.add_dependency "httparty"
+end

data/lib/github-api.rb

@@ -0,0 +1,7 @@
+require 'httparty'
+
+require 'github-api/other'
+require 'github-api/repo'
+require 'github-api/user'
+
+

data/lib/github-api/other.rb

@@ -0,0 +1,99 @@
+module GithubApi
+  
+  # TODO: Generally there's a problem with accessing data via data["sha"]. Find a way to streamline this to: commit.sha
+  # TODO: Repo JSON is different when creating, getting all or getting one. Find a way to merge this
+
+  #  HTTP class
+  # -------------------------------------
+
+  class HTTP
+    include HTTParty
+    format :json
+    base_uri 'https://api.github.com'
+  end
+  
+  #  Reference class
+  # -------------------------------------
+  
+  class Reference
+    
+    attr_accessor :repo, :data
+    
+    def initialize(repo, data)
+      @repo = repo
+      @data = data
+    end
+    
+    def commit
+      # TODO: Object in ref is not always a commit.
+      @repo.commit(data["object"]["sha"])
+    end
+    
+  end
+  
+  #  Commit class
+  # -------------------------------------
+  
+  class Commit
+    
+    attr_accessor :repo, :data
+    
+    def initialize(repo, data)
+      @repo = repo
+      @data = data
+    end
+    
+    def tree
+      @repo.tree(data["tree"]["sha"])
+    end
+    
+  end
+  
+  #  Tree class
+  # -------------------------------------
+  
+  class Tree
+    
+    attr_accessor :repo, :data
+    
+    def initialize(repo, data)
+      @repo = repo
+      @data = data
+    end
+    
+    def file(path)
+      blob_ref = data["tree"].find { |b| b["path"] == path}
+      unless blob_ref.nil?
+        sha = blob_ref["sha"]
+        @repo.blob(sha)
+      else
+        # throw error because the blob is not there
+      end
+    end
+    
+  end
+  
+  #  Blob class
+  # -------------------------------------
+  
+  class Blob
+    
+    attr_accessor :content, :encoding, :path
+    
+    def initialize(attributes={}) 
+      @encoding = "utf-8"
+      attributes.each { |key, val| send("#{key}=", val) if respond_to?("#{key}=") }
+    end
+    
+    def to_hash
+      {
+        :type => "blob",
+        :path => @path,
+        :content => @content,
+        :encoding => @encoding
+      }
+    end
+    
+  end
+  
+end

data/lib/github-api/repo.rb

@@ -0,0 +1,124 @@
+module GithubApi
+class Repo
+  
+  attr_accessor :data, :name
+  
+  def initialize(user, data)
+    @user = user
+    @data = data
+    @name = data["name"]
+    @trees = []
+    @commits = []
+    @refs = []
+    @blobs = []
+  end
+  
+  #   Trees
+  # ------------------------------------------------------------------------------
+  
+  def tree(sha)
+    puts "SHA: #{sha}"
+    # TODO: it may be smart to just load all trees at one time
+    tre = @trees.find { |t| t.data["sha"] == sha }
+    if tre.nil?
+      response = GithubApi::HTTP.get("/repos/#{@user.data['login']}/#{@name}/git/trees/" + sha).parsed_response
+      tre = GithubApi::Tree.new(self, response)
+      @trees << tre
+    end
+    tre
+  end
+  
+  def create_tree(blobs)
+    # TODO: Check if blobs have path names in them. It is required
+    # Throw error if not
+    response = GithubApi::HTTP.post("/repos/#{@user.data['login']}/#{@name}/git/trees", 
+      :query => {
+        :access_token => @user.token
+      },
+      :body => {
+        :tree => blobs.map { |blob| blob.to_hash }
+      }.to_json
+    ).parsed_response
+    
+    @trees << Tree.new(self, response)
+    @trees.last
+  end
+  
+  #   Commits
+  # ------------------------------------------------------------------------------
+  
+  def commit(sha)
+    # TODO: it may be smart to just load all commits at one time
+    com = @commits.find { |c| c.data["sha"] == sha }
+    if com.nil?
+      response = GithubApi::HTTP.get("/repos/#{@user.data['login']}/#{@name}/git/commits/" + sha).parsed_response
+      com = GithubApi::Commit.new(self, response)
+      @commits << com
+    end
+    com
+  end
+  
+  def create_initial_commit(sha, message)
+    response = GithubApi::HTTP.post("/repos/#{@user.data['login']}/#{@name}/git/commits", 
+      :query => {
+        :access_token => @user.token
+      },
+      :body => {
+        :message => message,
+        :tree => sha
+      }.to_json
+    ).parsed_response
+    
+    @commits << GithubApi::Commit.new(self, response)
+    @commits.last
+  end
+  
+  #   References
+  # ------------------------------------------------------------------------------
+  
+  def ref(name)
+    # TODO: it may be smart to just load all refs at one time
+    reference = @refs.find { |r| r.data["ref"] == name }
+    if reference.nil?
+      response = GithubApi::HTTP.get("/repos/#{@user.data['login']}/#{@name}/git/refs/" + name).parsed_response
+      reference = GithubApi::Reference.new(self, response)
+      @refs << reference
+    end
+    reference
+  end
+  
+  def create_ref(name, sha)
+    response = GithubApi::HTTP.post("/repos/#{@user.data['login']}/#{@name}/git/refs", 
+      :query => {
+        :access_token => @user.token
+      },
+      :body => {
+        :ref => name,
+        :sha => sha
+      }.to_json
+    ).parsed_response
+    
+    @refs << GithubApi::Reference.new(self, response)
+    @refs.last
+  end
+  
+  #   Blobs
+  # ------------------------------------------------------------------------------
+  
+  def blob(sha)
+    # TODO: it may be smart to just load all blobs at one time
+    blo = @blobs.find { |b| b.data["sha"] == sha }
+    if blo.nil?
+      response = GithubApi::HTTP.get("/repos/#{@user.data['login']}/#{@name}/git/blobs/" + sha,
+        :headers => {
+          'Content-Type' => 'application/vnd.github.beta.raw' 
+        }
+      ).parsed_response
+      blo = GithubApi::Blob.new(response)
+      @blobs << blo
+    end
+    blo
+  end
+  
+end
+end

data/lib/github-api/user.rb

@@ -0,0 +1,47 @@
+module GithubApi
+class User
+  
+  attr_accessor :data, :token
+  
+  def initialize(token)
+    @token = token
+    @data = GithubApi::HTTP.get("/user", :query => {:access_token => @token})
+    @repos = []
+  end
+  
+  def has_repo?(name)
+    load_repos if @repos.empty?
+    @repos.find { |repo| repo.name == name }
+  end
+  
+  def repos
+    load_repos if @repos.empty?
+    @repos
+  end
+  
+  def load_repos
+    response = GithubApi::HTTP.get("/user/repos", :query => {:access_token => @token}).parsed_response
+    response.each do |repo|
+      @repos << Repo.new(self, repo)
+    end
+  end
+  
+  def create_repo(name, params)
+    body = {:name => name}.merge(params)
+    
+    response = GithubApi::HTTP.post("/user/repos", 
+      :query => { :access_token => @token},
+      :body => body.to_json
+    ).parsed_response
+    
+    @repos << Repo.new(self, response)
+    @repos.last
+  end
+  
+  def repo(name)
+    load_repos if @repos.empty?
+    @repos.find { |repo| repo.name == name }
+  end
+  
+end
+end

data/lib/github-api/version.rb

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

data/spec/blob_spec.rb

@@ -0,0 +1,12 @@
+require 'github-api'
+
+describe GithubApi::Blob do
+   
+  describe "to_json" do
+    it "should return valid JSON" do
+      repo = GithubApi::Blob.new("Some content", "utf-8")
+      repo.token.should eql("124234FC7687687SSSCC")
+    end
+  end
+  
+end

data/spec/repo_spec.rb

@@ -0,0 +1,5 @@
+require 'github-api'
+
+describe GithubApi::Repo do
+  
+end

data/spec/user_spec.rb

@@ -0,0 +1,12 @@
+require 'github-api'
+
+describe GithubApi::User do
+   
+  describe "new" do
+    it "should initialize with token" do
+      repo = GithubApi::User.new("124234FC7687687SSSCC")
+      repo.token.should eql("124234FC7687687SSSCC")
+    end
+  end
+  
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification 
+name: github-api
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Rune Madsen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-11-04 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 6
+        version: "2.6"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+description: A simple gem to simplify requests to the Github API
+email: 
+- rune@runemadsen.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .DS_Store
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- github-api.gemspec
+- lib/github-api.rb
+- lib/github-api/other.rb
+- lib/github-api/repo.rb
+- lib/github-api/user.rb
+- lib/github-api/version.rb
+- spec/blob_spec.rb
+- spec/repo_spec.rb
+- spec/user_spec.rb
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: github-api
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: A simple gem to simplify requests to the Github API
+test_files: 
+- spec/blob_spec.rb
+- spec/repo_spec.rb
+- spec/user_spec.rb