firim 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 71ce22fb2fae197455cca05de2c9e26dea236a89
+  data.tar.gz: 4fb4e7dbfd738e0c2b61c2e5b47c84f2c55a06d7
+SHA512:
+  metadata.gz: f5349626a9c64773773b7dd094e315ce5f6f06ca7f11dccdafeb38a8551769fcafa5d054d2737c41784854c1e1b958b58f55a148d743022242a158497f7f00be
+  data.tar.gz: e1c696a1ff9b3e678a106f712a0c921b4cdb2db20cdbb3bf0a2680854de1a75c97f3ddd5bb78f77f618b221444f971977cc517e1d95fb62f8cba9e8ac446aaf2

data/README.md

@@ -0,0 +1,58 @@
+# Firim
+
+Firim is a command tool to directly upload ipa and change app infomation on fir.im. fir.im is a Beta APP host website, you can upload ipa for AdHoc or InHouse distribution for testing.
+
+## Getting Started
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'firim'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install firim
+
+## Quick Start
+
+* `cd [your_project_folder]`
+* `firim init`
+* Enter your fir.im API Token (From [Fir.im](http://fir.im/apps))
+* `firim -i [your_ipa_path]`
+
+# Usage
+
+Use with fastlane [fastlane-plugin-firim](fastlane-plugin-firim/)
+
+You can specify the app infomations in `Firimfile`, To get a list of available options run
+
+    firim --help
+    
+Upload with icon ***NOTICE: Icon must be jpg format***
+
+    firim -i [your_ipa_path] -l [your_icon_path]
+
+# Need help?
+
+Please submit an issue on GitHub and provide information about your setup
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [https://github.com/whlsxl/firim](https://github.com/whlsxl/firim). This project is intended to be a safe, welcoming space for collaboration.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+# TODO
+
+* Export all app infomation to a file 
+* Generate a web page show all the app's link and infomations
+* Show the app list, and export all app infomations to a file

data/bin/firim

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+$:.push File.expand_path("../../lib", __FILE__)
+
+require 'firim'
+Firim::CommandsGenerator.start

data/lib/assets/FirimfileDefault

@@ -0,0 +1,5 @@
+###################### More Options ######################
+# If you want to have even more control, check out the documentation
+# https://github.com/fastlane/fastlane/blob/master/deliver/Deliverfile.md
+
+firim_api_token "[[FIRIM_API_TOKEN]]" # The fir.im api token

data/lib/firim.rb

@@ -0,0 +1,20 @@
+require 'firim/commands_generator'
+require 'firim/detect_values'
+require 'firim/options'
+require 'firim/runner'
+require 'firim/setup'
+require "firim/version"
+
+require 'fastlane_core'
+
+module Firim
+  class << self
+  end
+
+  Helper = FastlaneCore::Helper # you gotta love Ruby: Helper.* should use the Helper class contained in FastlaneCore
+  UI = FastlaneCore::UI
+
+  # Constant that captures the root Pathname for the project. Should be used for building paths to assets or other
+  # resources that code needs to locate locally
+  ROOT = Pathname.new(File.expand_path('../..', __FILE__))
+end

data/lib/firim/commands_generator.rb

@@ -0,0 +1,68 @@
+require 'commander'
+
+module Firim
+  class CommandsGenerator
+    include Commander::Methods
+
+    # def self.start
+    #   FastlaneCore::UpdateChecker.start_looking_for_update('deliver')
+    #   self.new.run
+    # ensure
+    #   FastlaneCore::UpdateChecker.show_update_status('deliver', Deliver::VERSION)
+    # end
+
+    def self.start
+      self.new.run
+    end
+
+    def run
+      program :version, Firim::VERSION
+      program :description, 'fir.im command tool'
+      program :help, 'Author', 'Hailong Wang <whlsxl+g@gmail.com>'
+      program :help, 'GitHub', 'https://github.com/fastlane/fastlane/tree/master/deliver'
+      program :help_formatter, :compact
+
+      FastlaneCore::CommanderGenerator.new.generate(Firim::Options.available_options)
+      global_option('--verbose') { $verbose = true }
+
+      always_trace!
+
+      command :run do |c|
+        c.syntax = 'firim'
+        c.description = 'Upload binary and infomations to Fir.im'
+        c.action do |args, options|
+          options = FastlaneCore::Configuration.create(Firim::Options.available_options, options.__hash__)
+          loaded = options.load_configuration_file("Firimfile")
+          loaded = true if options[:firim_api_token]
+          unless loaded
+            if UI.confirm("No firim configuration found in the current directory. Do you want to setup firim?")
+              require 'deliver/setup'
+              Firim::Setup.new.run(options)
+              return 0
+            end
+          end
+          Firim::Runner.new(options).run
+        end
+      end
+
+      command :init do |c|
+        c.syntax = 'firim init'
+        c.description = 'Create the initial `Firimfile` configuration'
+        c.action do |args, options|
+          if File.exist?("Firimfile") or File.exist?("fastlane/Firimfile")
+            UI.important("You already got a running firim setup in this directory")
+            return 0
+          end
+
+          require 'firim/setup'
+          options = FastlaneCore::Configuration.create(Firim::Options.available_options, options.__hash__)
+          Firim::Setup.new.run(options)
+        end
+      end
+
+      default_command :run
+
+      run!
+    end
+  end
+end

data/lib/firim/detect_values.rb

@@ -0,0 +1,41 @@
+module Firim
+  class DetectValues
+    def run!(options)
+      find_firim_api_token(options)
+      find_app_identifier(options)
+      find_app_name(options)
+      find_version(options)
+      find_build_version(options)
+    end
+
+    def find_app_identifier(options)
+      identifier = FastlaneCore::IpaFileAnalyser.fetch_app_identifier(options[:ipa])
+      if identifier.to_s.length != 0
+        options[:app_identifier] = identifier
+      else
+        UI.user_error!("Could not find ipa with app identifier '#{options[:app_identifier]}' in your iTunes Connect account (#{options[:username]} - Team: #{Spaceship::Tunes.client.team_id})")
+      end
+    end
+
+    def find_app_name(options)
+      return if options[:app_name]
+      plist = FastlaneCore::IpaFileAnalyser.fetch_info_plist_file(options[:ipa])
+      options[:app_name] ||= plist['CFBundleDisplayName']
+      options[:app_name] ||= plist['CFBundleName']
+    end
+
+    def find_version(options)
+      options[:app_version] ||= FastlaneCore::IpaFileAnalyser.fetch_app_version(options[:ipa])
+    end
+
+    def find_build_version(options)
+      plist = FastlaneCore::IpaFileAnalyser.fetch_info_plist_file(options[:ipa])
+      options[:app_build_version] = plist['CFBundleVersion']
+    end
+
+    def find_firim_api_token(options)
+      return if options[:firim_api_token]
+      options[:firim_api_token] ||= UI.input("The API Token of fir.im: ")
+    end
+  end
+end

data/lib/firim/options.rb

@@ -0,0 +1,78 @@
+require 'fastlane_core'
+require 'credentials_manager'
+
+module Firim
+  class Options
+    def self.available_options
+      [
+        # firim info
+        FastlaneCore::ConfigItem.new(key: :firim_api_token,
+                                     short_option: "-a",
+                                     description: "fir.im user api token"),
+
+        # Content path
+        FastlaneCore::ConfigItem.new(key: :ipa,
+                                     short_option: "-i",
+                                     env_name: "DELIVER_IPA_PATH",
+                                     description: "Path to your ipa file",
+                                     default_value: Dir["*.ipa"].first,
+                                     verify_block: proc do |value|
+                                       UI.user_error!("Could not find ipa file at path '#{value}'") unless File.exist?(value)
+                                       UI.user_error!("'#{value}' doesn't seem to be an ipa file") unless value.end_with?(".ipa")
+                                     end,
+                                     conflicting_options: [:pkg],
+                                     conflict_block: proc do |value|
+                                       UI.user_error!("You can't use 'ipa' and '#{value.key}' options in one run.")
+                                     end),
+        FastlaneCore::ConfigItem.new(key: :icon,
+                                     description: "Path to the app icon, MUST BE jpg",
+                                     optional: true,
+                                     short_option: "-l",
+                                     verify_block: proc do |value|
+                                       UI.user_error!("Could not find png file at path '#{value}'") unless File.exist?(value)
+                                       UI.user_error!("'#{value}' doesn't seem to be a png file") unless value.end_with?(".jpg")
+                                     end),
+        # APP info
+        FastlaneCore::ConfigItem.new(key: :app_identifier,
+                                     description: "The app's identifier",
+                                     optional: true),
+        FastlaneCore::ConfigItem.new(key: :app_name,
+                                     description: "The app's name",
+                                     optional: true),
+        FastlaneCore::ConfigItem.new(key: :app_desc,
+                                     description: "The app's desc",
+                                     optional: true),
+        FastlaneCore::ConfigItem.new(key: :app_short,
+                                     description: "The app's short URL",
+                                     optional: true),
+        FastlaneCore::ConfigItem.new(key: :app_is_opened,
+                                     description: "APP's download link whether opened",
+                                     is_string: false,
+                                     optional: true),
+        FastlaneCore::ConfigItem.new(key: :app_is_show_plaza,
+                                     description: "Whether the app show in plaza",
+                                     is_string: false,
+                                     optional: true),
+        FastlaneCore::ConfigItem.new(key: :app_passwd,
+                                     description: "The app's download page password",
+                                     optional: true),
+        FastlaneCore::ConfigItem.new(key: :app_store_link_visible,
+                                     description: "Whether show store link in download page",
+                                     is_string: false,
+                                     optional: true),
+        FastlaneCore::ConfigItem.new(key: :app_version,
+                                     description: "The app's version",
+                                     optional: true),
+        FastlaneCore::ConfigItem.new(key: :app_build_version,
+                                     description: "The app's build version",
+                                     optional: true),
+        FastlaneCore::ConfigItem.new(key: :app_release_type,
+                                     description: "The app's release type (Adhoc, Inhouse)",
+                                     optional: true),
+        FastlaneCore::ConfigItem.new(key: :app_changelog,
+                                     description: "The app's changelog",
+                                     optional: true)
+      ]
+    end
+  end
+end

data/lib/firim/runner.rb

@@ -0,0 +1,145 @@
+require 'faraday' # HTTP Client
+require 'faraday_middleware'
+# require 'logger'
+
+module Firim
+  class Runner
+    attr_accessor :options
+    attr_reader :firim_client
+
+    def self.firim_hostname
+      return "http://api.fir.im/"
+    end
+
+    def initialize(options)
+      self.options = options
+      @app_info = {}
+
+      conn_options = {
+       request: {
+          timeout:       300,
+          open_timeout:  300
+        }
+      }
+
+      @firim_client = Faraday.new(self.class.firim_hostname, conn_options) do |c|
+        c.request  :url_encoded             # form-encode POST params
+        c.adapter  :net_http
+        c.response :json, :content_type => /\bjson$/
+      end
+
+      Firim::DetectValues.new.run!(self.options)
+      FastlaneCore::PrintTable.print_values(config: options, title: "firim #{Firim::VERSION} Summary")
+    end
+
+    def run
+      # FastlaneCore::PrintTable.print_values(config: get_app_info, title: "Current online infomation")
+      @app_info.merge( upload_binary_and_icon )
+
+    end
+
+    def validation_response response_data
+      error_code = response_data['errors']['code'].to_int rescue 0
+      if error_code == 100020
+        UI.user_error!("Firim API Token(#{options[:firim_api_token]}) not correct")
+      end
+    end
+
+    def get_app_info
+      app_info_path = "apps/latest/" + options[:app_identifier]
+      response = self.firim_client.get app_info_path, { :api_token => options[:firim_api_token], :type => "ios" }
+      info = response.body == nil ? {} : response.body
+      validation_response info
+      info
+    end
+
+    def upload_binary_and_icon
+      upload_publish_path = "apps/"
+      response = self.firim_client.post do |req|
+        req.url upload_publish_path
+        req.body = { :type => 'ios', :bundle_id => options[:app_identifier], :api_token => options[:firim_api_token] }
+      end
+      info = response.body
+      validation_response info
+      begin
+        upload_binary info['cert']['binary']
+        upload_icon info['cert']['icon']
+      rescue Exception => e
+        # raise UI.user_error!("Firim Server error #{e}\n #{info}")
+        raise e
+      end
+      info.select { |k, v| ["id", "type", "short"].include?(k) }
+    end
+
+    def get_upload_conn
+      conn_options = {
+       request: {
+          timeout:       1000,
+          open_timeout:  300
+        }
+      }
+      Faraday.new(nil, conn_options) do |c|
+        c.request :multipart
+        c.request :url_encoded
+        c.response :json, content_type: /\bjson$/
+        c.adapter :net_http
+      end
+    end
+
+    def upload_binary binary_info
+      params = {
+        'key' => binary_info['key'],
+        'token' => binary_info['token'],
+        'file' => Faraday::UploadIO.new(self.options[:ipa], 'application/octet-stream'),
+        'x:name' => self.options[:app_name],
+        'x:version' => self.options[:app_version],
+        'x:build' => self.options[:app_build_version]
+      }
+      params['x:release_type'] = self.options[:app_release_type] if self.options[:app_release_type]
+      params['x:changelog'] = self.options[:app_changelog] if self.options[:app_changelog]
+      binary_conn = get_upload_conn
+      UI.message "Start upload #{self.options[:app_name]} binary..."
+      response = binary_conn.post binary_info['upload_url'], params
+      unless response.body['is_completed']
+        raise UI.user_error!("Upload binary to Qiniu error #{response.body}")
+      end
+      UI.success 'Upload binary successed!'
+    end
+
+    def upload_icon icon_info
+      return unless self.options[:icon]
+      binary_conn = get_upload_conn
+      params = {
+        'key' => icon_info['key'],
+        'token' => icon_info['token'],
+        'file' => Faraday::UploadIO.new(self.options[:icon], 'image/jpeg'),
+      }
+      UI.message "Start upload #{self.options[:app_name]} icon..."
+      response = binary_conn.post icon_info['upload_url'], params
+      unless response.body['is_completed']
+        raise UI.user_error!("Upload icon to Qiniu error #{response.body}")
+      end
+      UI.success 'Upload icon successed!'
+    end
+
+    def update_app_info id
+      params = {
+        :api_token => options[:firim_api_token]
+      }
+      ["name", "desc", "short", "is_opened", "is_show_plaza", "passwd", "store_link_visible"].each do |k|
+        key = :"app_#{k}"
+        params[k] = options[key] if options[key] != nil
+      end
+
+      update_app_info_path = "apps/#{id}"
+      response = self.firim_client.put do |req|
+        req.url update_app_info_path
+        req.body = params
+      end
+      info = response.body
+      validation_response info
+      UI.success "Update app info successed!"
+    end
+
+  end
+end

data/lib/firim/setup.rb

@@ -0,0 +1,25 @@
+
+module Firim
+  class Setup
+    def run(options)
+      containing = (File.directory?("fastlane") ? 'fastlane' : '.')
+      file_path = File.join(containing, 'Firimfile')
+      data = generate_firim_file(containing, options)
+      setup_firim(file_path, data, containing, options)
+    end
+
+    def generate_firim_file(firim_path, options)
+      # Generate the final Firimfile here
+      firim = File.read("#{Firim::ROOT}/lib/assets/FirimfileDefault")
+      firim.gsub!("[[FIRIM_API_TOKEN]]", options[:firim_api_token])
+      return firim
+    end
+
+    def setup_firim(file_path, data, firim_path, options)
+      File.write(file_path, data)
+
+      UI.success("Successfully created new Firimfile at path '#{file_path}'")
+    end
+
+  end
+end

data/lib/firim/version.rb

@@ -0,0 +1,3 @@
+module Firim
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification
+name: firim
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- whlsxl
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fastlane_core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.52.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.52.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: credentials_manager
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.16.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.16.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: |-
+  fir.im command tool,
+   Upload ipa to fir.im
+email:
+- whlsxl+g@gmail.com
+executables:
+- firim
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/firim
+- lib/assets/FirimfileDefault
+- lib/firim.rb
+- lib/firim/commands_generator.rb
+- lib/firim/detect_values.rb
+- lib/firim/options.rb
+- lib/firim/runner.rb
+- lib/firim/setup.rb
+- lib/firim/version.rb
+homepage: https://github.com/whlsxl/firim
+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.5.1
+signing_key: 
+specification_version: 4
+summary: fir.im command tool
+test_files: []